Kibo ProductAdmin Service v1
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Authentication
- HTTP Authentication, scheme: bearer
JWT Authorization header using the Bearer scheme.
Enter 'Bearer' [space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
oAuth2 authentication.
- Flow: clientCredentials
- Token URL = /platform/applications/internal/access-tokens/oauth/
Attribute
get__commerce_catalog_admin_attributedefinition_attributes
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/attributes \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/attributes HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/attributes',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/attributes', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/attributes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/attributes", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/attributes
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| startIndex | query | integer(int32) | false | none |
| pageSize | query | integer(int32) | false | none |
| sortBy | query | string | false | none |
| filter | query | string | false | none |
| responseGroups | query | string | false | none |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":null,"stringValue":null},"localizedContent":[{}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeCollection |
post__commerce_catalog_admin_attributedefinition_attributes
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/attributedefinition/attributes \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/attributedefinition/attributes HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/attributedefinition/attributes',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/attributedefinition/attributes', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/attributedefinition/attributes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/attributedefinition/attributes", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/attributedefinition/attributes
Add / Create Attribute
Body parameter
{
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Attribute | false | none |
Example responses
200 Response
{
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":"string","stringValue":"string"}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Attribute |
get_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| responseGroups | query | string | false | none |
Example responses
200 Response
{
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":"string","stringValue":"string"}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Attribute |
put_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}
Update attribute
Body parameter
{
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| body | body | Attribute | false | none |
Example responses
200 Response
{
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":"string","stringValue":"string"}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Attribute |
delete_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}
Delete attribute
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}LocalizedContent{localeCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| localeCode | path | string | true | none |
Example responses
200 Response
{
"localeCode": "string",
"name": "string",
"description": "string"
}
{"localeCode":"string","name":"string","description":"string"}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeLocalizedContent |
put_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}LocalizedContent{localeCode}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"localeCode": "string",
"name": "string",
"description": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}
Body parameter
{
"localeCode": "string",
"name": "string",
"description": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| localeCode | path | string | true | none |
| body | body | AttributeLocalizedContent | false | none |
Example responses
200 Response
{
"localeCode": "string",
"name": "string",
"description": "string"
}
{"localeCode":"string","name":"string","description":"string"}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeLocalizedContent |
delete_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}LocalizedContent{localeCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent/{localeCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| localeCode | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}_LocalizedContent
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
Example responses
200 Response
[
{
"localeCode": "string",
"name": "string",
"description": "string"
}
]
[{"localeCode":"string","name":"string","description":"string"}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [AttributeLocalizedContent] | false | none | [Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display an attribute in multiple languages yet manage it as a single attribute internally.] |
| » localeCode | string¦null | false | none | Language used for the attribute name and description. Currently, only en_US is supported. |
| » name | string¦null | false | none | Name of the attribute in the language specified by LocaleCode. |
| » description | string¦null | false | none | Description of the attribute in the language specified by LocaleCode. |
post_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}_LocalizedContent
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"localeCode": "string",
"name": "string",
"description": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent
Body parameter
{
"localeCode": "string",
"name": "string",
"description": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| body | body | AttributeLocalizedContent | false | none |
Example responses
200 Response
{
"localeCode": "string",
"name": "string",
"description": "string"
}
{"localeCode":"string","name":"string","description":"string"}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeLocalizedContent |
put_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}_LocalizedContent
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"localeCode": "string",
"name": "string",
"description": "string"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/LocalizedContent
Body parameter
[
{
"localeCode": "string",
"name": "string",
"description": "string"
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| body | body | AttributeLocalizedContent | false | none |
Example responses
200 Response
[
{
"localeCode": "string",
"name": "string",
"description": "string"
}
]
[{"localeCode":"string","name":"string","description":"string"}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [AttributeLocalizedContent] | false | none | [Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display an attribute in multiple languages yet manage it as a single attribute internally.] |
| » localeCode | string¦null | false | none | Language used for the attribute name and description. Currently, only en_US is supported. |
| » name | string¦null | false | none | Name of the attribute in the language specified by LocaleCode. |
| » description | string¦null | false | none | Description of the attribute in the language specified by LocaleCode. |
get_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}VocabularyValues{value}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
Example responses
200 Response
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":"string","stringValue":"string"}],"displayOrder":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeVocabularyValue |
put_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}VocabularyValues{value}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}
Update attribute vocabulary value
Body parameter
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| body | body | AttributeVocabularyValue | false | none |
Example responses
200 Response
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":"string","stringValue":"string"}],"displayOrder":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeVocabularyValue |
delete_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}VocabularyValues{value}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}
Delete Attribute Vocabulary Value
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}VocabularyValues{value}LocalizedContent{localeCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| localeCode | path | string | true | none |
Example responses
200 Response
{
"localeCode": "string",
"stringValue": "string"
}
{"localeCode":"string","stringValue":"string"}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeVocabularyValueLocalizedContent |
put_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}VocabularyValues{value}LocalizedContent{localeCode}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"localeCode": "string",
"stringValue": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}
Body parameter
{
"localeCode": "string",
"stringValue": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| localeCode | path | string | true | none |
| body | body | AttributeVocabularyValueLocalizedContent | false | none |
Example responses
200 Response
{
"localeCode": "string",
"stringValue": "string"
}
{"localeCode":"string","stringValue":"string"}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeVocabularyValueLocalizedContent |
delete_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}VocabularyValues{value}LocalizedContent{localeCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| localeCode | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}VocabularyValues{value}_LocalizedContent
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
Example responses
200 Response
[
{
"localeCode": "string",
"stringValue": "string"
}
]
[{"localeCode":"string","stringValue":"string"}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [AttributeVocabularyValueLocalizedContent] | false | none | [Attribute Value Localized Resource] |
| » localeCode | string¦null | false | none | Language used for the string attribute value. Currently, only en_US is supported. |
| » stringValue | string¦null | false | none | Localized Value in the language of the locale code |
put_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}VocabularyValues{value}_LocalizedContent
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"localeCode": "string",
"stringValue": "string"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent
Body parameter
[
{
"localeCode": "string",
"stringValue": "string"
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| body | body | AttributeVocabularyValueLocalizedContent | false | none |
Example responses
200 Response
[
{
"localeCode": "string",
"stringValue": "string"
}
]
[{"localeCode":"string","stringValue":"string"}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [AttributeVocabularyValueLocalizedContent] | false | none | [Attribute Value Localized Resource] |
| » localeCode | string¦null | false | none | Language used for the string attribute value. Currently, only en_US is supported. |
| » stringValue | string¦null | false | none | Localized Value in the language of the locale code |
get_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}_VocabularyValues
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| responseGroups | query | string | false | none |
Example responses
200 Response
[
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
]
[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":"string","stringValue":"string"}],"displayOrder":0}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [AttributeVocabularyValue] | false | none | [Value of an attribute] |
| » valueSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence. |
| » value | object¦null | false | none | The actual value of the attribute vocabulary. This value must be unique within the vocabulary for a single attribute and match the datatype of the attribute. String data type requires a canonical value here or one will be system generated if null. The actual string content displayed to users should be stored as Content. String values require content to be present. Once this value is set it cannot be changed. |
| » mappedGenericValues | [object]¦null | false | none | The actual values of the related generic attribute. This value must match the datatype of the attribute and already exist within the Vocabulary values of the related ValueMappingAttribute. Only supporting string at this time. |
| » productName | string¦null | false | none | The ProductName when the Attribute DataType is ProductCode. |
| » content | AttributeVocabularyValueLocalizedContent | false | none | Attribute Value Localized Resource |
| »» localeCode | string¦null | false | none | Language used for the string attribute value. Currently, only en_US is supported. |
| »» stringValue | string¦null | false | none | Localized Value in the language of the locale code |
| » localizedContent | [AttributeVocabularyValueLocalizedContent]¦null | false | none | The Content of an attribute value. This content is in multiple locals supported by the master catalog and is only valid for String DataType. |
| » displayOrder | integer(int32)¦null | false | none | The order in which the attribute value displays. If you omit a value for this property, Mozu infers the display order from the attribute value's position the list. |
post_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}_VocabularyValues
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues
Add attribute vocabulary value
Body parameter
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| body | body | AttributeVocabularyValue | false | none |
Example responses
200 Response
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":"string","stringValue":"string"}],"displayOrder":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeVocabularyValue |
put_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}_VocabularyValues
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues
Update attribute vocabulary values
Body parameter
[
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| body | body | AttributeVocabularyValue | false | none |
Example responses
200 Response
[
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
]
[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":"string","stringValue":"string"}],"displayOrder":0}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [AttributeVocabularyValue] | false | none | [Value of an attribute] |
| » valueSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence. |
| » value | object¦null | false | none | The actual value of the attribute vocabulary. This value must be unique within the vocabulary for a single attribute and match the datatype of the attribute. String data type requires a canonical value here or one will be system generated if null. The actual string content displayed to users should be stored as Content. String values require content to be present. Once this value is set it cannot be changed. |
| » mappedGenericValues | [object]¦null | false | none | The actual values of the related generic attribute. This value must match the datatype of the attribute and already exist within the Vocabulary values of the related ValueMappingAttribute. Only supporting string at this time. |
| » productName | string¦null | false | none | The ProductName when the Attribute DataType is ProductCode. |
| » content | AttributeVocabularyValueLocalizedContent | false | none | Attribute Value Localized Resource |
| »» localeCode | string¦null | false | none | Language used for the string attribute value. Currently, only en_US is supported. |
| »» stringValue | string¦null | false | none | Localized Value in the language of the locale code |
| » localizedContent | [AttributeVocabularyValueLocalizedContent]¦null | false | none | The Content of an attribute value. This content is in multiple locals supported by the master catalog and is only valid for String DataType. |
| » displayOrder | integer(int32)¦null | false | none | The order in which the attribute value displays. If you omit a value for this property, Mozu infers the display order from the attribute value's position the list. |
post_commerce_catalog_admin_attributedefinition_attributes{attributeFQN}VocabularyValues{value}_localizedContent
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/localizedContent \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/localizedContent HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"localeCode": "string",
"stringValue": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/localizedContent',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/localizedContent',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/localizedContent', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/localizedContent', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/localizedContent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/localizedContent", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/localizedContent
Body parameter
{
"localeCode": "string",
"stringValue": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| body | body | AttributeVocabularyValueLocalizedContent | false | none |
Example responses
200 Response
{
"localeCode": "string",
"stringValue": "string"
}
{"localeCode":"string","stringValue":"string"}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeVocabularyValueLocalizedContent |
get__commerce_catalog_admin_attributedefinition_attributes_typerules
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/attributes/typerules \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/attributes/typerules HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/attributes/typerules',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/attributes/typerules',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/attributes/typerules', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/attributes/typerules', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/attributes/typerules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/attributes/typerules", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/attributes/typerules
Retrieves a paged list of attribute type rules according to any specified filter criteria and sort options.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| startIndex | query | integer(int32) | false | Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0. Optional. |
| pageSize | query | integer(int32) | false | Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200. Optional. |
| sortBy | query | string | false | The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional. |
| filter | query | string | false | A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional. |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"attributeInputType": "string",
"attributeDataType": "string",
"attributeValueType": "string",
"attributeUsageType": "string"
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"attributeInputType":"string","attributeDataType":"string","attributeValueType":"string","attributeUsageType":"string"}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeTypeRuleCollection |
Category
get__commerce_catalog_admin_categories
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/categories \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/categories HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/categories',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/categories',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/categories', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/categories', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/categories");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/categories", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/categories
Retrieves a list of categories according to any specified filter criteria and sort options.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| startIndex | query | integer(int32) | false | Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. The default value is 0. |
| pageSize | query | integer(int32) | false | Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200. |
| sortBy | query | string | false | The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. |
| filter | query | string | false | A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional. |
| responseGroups | query | string | false | none |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"id": 0,
"categoryType": "string",
"catalogId": 0,
"parentCategoryId": 0,
"parentCategoryCode": "string",
"parentCategoryName": "string",
"parentIsActive": true,
"categoryCode": "string",
"isActive": true,
"isDisplayed": true,
"sequence": 0,
"content": {
"localeCode": "string",
"name": "string",
"slug": "string",
"description": "string",
"pageTitle": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"categoryImages": [
{
"id": null,
"localeCode": null,
"imageLabel": null,
"altText": null,
"imageUrl": null,
"cmsId": null,
"videoUrl": null,
"mediaType": null,
"sequence": null
}
]
},
"dynamicExpression": {
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
null
],
"left": "string",
"operator": "string",
"right": {}
}
},
"productCount": 0,
"childCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"shouldSlice": true
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"id":0,"categoryType":"string","catalogId":0,"parentCategoryId":0,"parentCategoryCode":"string","parentCategoryName":"string","parentIsActive":true,"categoryCode":"string","isActive":true,"isDisplayed":true,"sequence":0,"content":{"localeCode":"string","name":"string","slug":"string","description":"string","pageTitle":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","categoryImages":[{"id":null,"localeCode":null,"imageLabel":null,"altText":null,"imageUrl":null,"cmsId":null,"videoUrl":null,"mediaType":null,"sequence":null}]},"dynamicExpression":{"text":"string","tree":{"type":"string","logicalOperator":"string","nodes":[null],"left":"string","operator":"string","right":{}}},"productCount":0,"childCount":0,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"},"shouldSlice":true}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CategoryPagedCollection |
post__commerce_catalog_admin_categories
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/categories \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/categories HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"id": 0,
"categoryType": "string",
"catalogId": 0,
"parentCategoryId": 0,
"parentCategoryCode": "string",
"parentCategoryName": "string",
"parentIsActive": true,
"categoryCode": "string",
"isActive": true,
"isDisplayed": true,
"sequence": 0,
"content": {
"localeCode": "string",
"name": "string",
"slug": "string",
"description": "string",
"pageTitle": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"categoryImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0
}
]
},
"dynamicExpression": {
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
null
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
},
"productCount": 0,
"childCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"shouldSlice": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/categories',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/categories',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/categories', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/categories', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/categories");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/categories", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/categories
Adds a new category to the catalog's category hierarchy. Specify a ParentCategoryID to determine where to locate the category in the hierarchy; if not specified it becomes a top-level category.
Body parameter
{
"id": 0,
"categoryType": "string",
"catalogId": 0,
"parentCategoryId": 0,
"parentCategoryCode": "string",
"parentCategoryName": "string",
"parentIsActive": true,
"categoryCode": "string",
"isActive": true,
"isDisplayed": true,
"sequence": 0,
"content": {
"localeCode": "string",
"name": "string",
"slug": "string",
"description": "string",
"pageTitle": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"categoryImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0
}
]
},
"dynamicExpression": {
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
null
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
},
"productCount": 0,
"childCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"shouldSlice": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| incrementSequence | query | boolean | false | Sets the sequence number of the category to the current max sequence value plus 1 (e.g. 5 + 1 = 6) |
| useProvidedId | query | boolean | false | If true, the provided Id value will be used as the CategoryId. If omitted or false, the system will generate a CategoryId |
| body | body | Category | false | Properties of the new category. Required properties ParentCategoryID and Content.Name. |
Example responses
200 Response
{
"id": 0,
"categoryType": "string",
"catalogId": 0,
"parentCategoryId": 0,
"parentCategoryCode": "string",
"parentCategoryName": "string",
"parentIsActive": true,
"categoryCode": "string",
"isActive": true,
"isDisplayed": true,
"sequence": 0,
"content": {
"localeCode": "string",
"name": "string",
"slug": "string",
"description": "string",
"pageTitle": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"categoryImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0
}
]
},
"dynamicExpression": {
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
null
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
},
"productCount": 0,
"childCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"shouldSlice": true
}
{"id":0,"categoryType":"string","catalogId":0,"parentCategoryId":0,"parentCategoryCode":"string","parentCategoryName":"string","parentIsActive":true,"categoryCode":"string","isActive":true,"isDisplayed":true,"sequence":0,"content":{"localeCode":"string","name":"string","slug":"string","description":"string","pageTitle":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","categoryImages":[{"id":0,"localeCode":"string","imageLabel":"string","altText":"string","imageUrl":"string","cmsId":"string","videoUrl":"string","mediaType":"string","sequence":0}]},"dynamicExpression":{"text":"string","tree":{"type":"string","logicalOperator":"string","nodes":[{"type":"string","logicalOperator":"string","nodes":[null],"left":"string","operator":"string","right":{}}],"left":"string","operator":"string","right":{}}},"productCount":0,"childCount":0,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"},"shouldSlice":true}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Category |
get_commerce_catalog_admin_categories{categoryId}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/categories/{categoryId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/categories/{categoryId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/categories/{categoryId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/categories/{categoryId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/categories/{categoryId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/categories/{categoryId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/categories/{categoryId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/categories/{categoryId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/categories/{categoryId}
Retrieves the details of a single category.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| categoryId | path | integer(int32) | true | Unique identifier of the category. |
Example responses
200 Response
{
"id": 0,
"categoryType": "string",
"catalogId": 0,
"parentCategoryId": 0,
"parentCategoryCode": "string",
"parentCategoryName": "string",
"parentIsActive": true,
"categoryCode": "string",
"isActive": true,
"isDisplayed": true,
"sequence": 0,
"content": {
"localeCode": "string",
"name": "string",
"slug": "string",
"description": "string",
"pageTitle": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"categoryImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0
}
]
},
"dynamicExpression": {
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
null
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
},
"productCount": 0,
"childCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"shouldSlice": true
}
{"id":0,"categoryType":"string","catalogId":0,"parentCategoryId":0,"parentCategoryCode":"string","parentCategoryName":"string","parentIsActive":true,"categoryCode":"string","isActive":true,"isDisplayed":true,"sequence":0,"content":{"localeCode":"string","name":"string","slug":"string","description":"string","pageTitle":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","categoryImages":[{"id":0,"localeCode":"string","imageLabel":"string","altText":"string","imageUrl":"string","cmsId":"string","videoUrl":"string","mediaType":"string","sequence":0}]},"dynamicExpression":{"text":"string","tree":{"type":"string","logicalOperator":"string","nodes":[{"type":"string","logicalOperator":"string","nodes":[null],"left":"string","operator":"string","right":{}}],"left":"string","operator":"string","right":{}}},"productCount":0,"childCount":0,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"},"shouldSlice":true}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Category |
put_commerce_catalog_admin_categories{categoryId}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/categories/{categoryId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/categories/{categoryId} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"id": 0,
"categoryType": "string",
"catalogId": 0,
"parentCategoryId": 0,
"parentCategoryCode": "string",
"parentCategoryName": "string",
"parentIsActive": true,
"categoryCode": "string",
"isActive": true,
"isDisplayed": true,
"sequence": 0,
"content": {
"localeCode": "string",
"name": "string",
"slug": "string",
"description": "string",
"pageTitle": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"categoryImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0
}
]
},
"dynamicExpression": {
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
null
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
},
"productCount": 0,
"childCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"shouldSlice": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/categories/{categoryId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/categories/{categoryId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/categories/{categoryId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/categories/{categoryId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/categories/{categoryId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/categories/{categoryId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/categories/{categoryId}
Modifies a category such as moving it to another location in the category tree, or changing whether it is visible on the storefront. This PUT replaces the existing resource, so be sure to include all the information that you want to maintain for the category. Any unspecified properties are set to null.
Body parameter
{
"id": 0,
"categoryType": "string",
"catalogId": 0,
"parentCategoryId": 0,
"parentCategoryCode": "string",
"parentCategoryName": "string",
"parentIsActive": true,
"categoryCode": "string",
"isActive": true,
"isDisplayed": true,
"sequence": 0,
"content": {
"localeCode": "string",
"name": "string",
"slug": "string",
"description": "string",
"pageTitle": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"categoryImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0
}
]
},
"dynamicExpression": {
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
null
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
},
"productCount": 0,
"childCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"shouldSlice": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| categoryId | path | integer(int32) | true | Unique identifier of the category that you want to modify. Required. |
| cascadeVisibility | query | boolean | false | If true, when changing the display option for the category, change it for all subcategories also. Optional. |
| body | body | Category | false | Properties of the category that you want to modify. Required properties ParentCategoryID and Content.Name. |
Example responses
200 Response
{
"id": 0,
"categoryType": "string",
"catalogId": 0,
"parentCategoryId": 0,
"parentCategoryCode": "string",
"parentCategoryName": "string",
"parentIsActive": true,
"categoryCode": "string",
"isActive": true,
"isDisplayed": true,
"sequence": 0,
"content": {
"localeCode": "string",
"name": "string",
"slug": "string",
"description": "string",
"pageTitle": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"categoryImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0
}
]
},
"dynamicExpression": {
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
null
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
},
"productCount": 0,
"childCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"shouldSlice": true
}
{"id":0,"categoryType":"string","catalogId":0,"parentCategoryId":0,"parentCategoryCode":"string","parentCategoryName":"string","parentIsActive":true,"categoryCode":"string","isActive":true,"isDisplayed":true,"sequence":0,"content":{"localeCode":"string","name":"string","slug":"string","description":"string","pageTitle":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","categoryImages":[{"id":0,"localeCode":"string","imageLabel":"string","altText":"string","imageUrl":"string","cmsId":"string","videoUrl":"string","mediaType":"string","sequence":0}]},"dynamicExpression":{"text":"string","tree":{"type":"string","logicalOperator":"string","nodes":[{"type":"string","logicalOperator":"string","nodes":[null],"left":"string","operator":"string","right":{}}],"left":"string","operator":"string","right":{}}},"productCount":0,"childCount":0,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"},"shouldSlice":true}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Category |
delete_commerce_catalog_admin_categories{categoryId}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/categories/{categoryId} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/categories/{categoryId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/categories/{categoryId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/categories/{categoryId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/categories/{categoryId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/categories/{categoryId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/categories/{categoryId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/categories/{categoryId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/categories/{categoryId}
Deletes the category specified by its category ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| categoryId | path | integer(int32) | true | Unique identifier of the category that you want to delete. |
| cascadeDelete | query | boolean | false | If true, any subcategories of a category are deleted when this category is deleted. Otherwise only the given category is deleted. Default is false. |
| forceDelete | query | boolean | false | If true, category (and optionally subcategories) will be deleted even if there are products referecing them. Default is false. |
| reassignToParent | query | boolean | false | If true, and child categories of the given category will be reassigned to the parent of the given category. Only applies if cascadeDelete is false. Default is false. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_categories{categoryId}_children
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/categories/{categoryId}/children \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/categories/{categoryId}/children HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/categories/{categoryId}/children',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/categories/{categoryId}/children',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/categories/{categoryId}/children', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/categories/{categoryId}/children', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/categories/{categoryId}/children");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/categories/{categoryId}/children", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/categories/{categoryId}/children
Retrieves the immediate subcategories of a category. This is a list of subcategories at the same level (siblings). You can use a list of siblings, for example, to display the categories in a horizontal list.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| categoryId | path | integer(int32) | true | Unique identifier of the category whose subcategories you want to get. |
Example responses
200 Response
{
"totalCount": 0,
"items": [
{
"id": 0,
"categoryType": "string",
"catalogId": 0,
"parentCategoryId": 0,
"parentCategoryCode": "string",
"parentCategoryName": "string",
"parentIsActive": true,
"categoryCode": "string",
"isActive": true,
"isDisplayed": true,
"sequence": 0,
"content": {
"localeCode": "string",
"name": "string",
"slug": "string",
"description": "string",
"pageTitle": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"categoryImages": [
{
"id": null,
"localeCode": null,
"imageLabel": null,
"altText": null,
"imageUrl": null,
"cmsId": null,
"videoUrl": null,
"mediaType": null,
"sequence": null
}
]
},
"dynamicExpression": {
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
null
],
"left": "string",
"operator": "string",
"right": {}
}
},
"productCount": 0,
"childCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"shouldSlice": true
}
]
}
{"totalCount":0,"items":[{"id":0,"categoryType":"string","catalogId":0,"parentCategoryId":0,"parentCategoryCode":"string","parentCategoryName":"string","parentIsActive":true,"categoryCode":"string","isActive":true,"isDisplayed":true,"sequence":0,"content":{"localeCode":"string","name":"string","slug":"string","description":"string","pageTitle":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","categoryImages":[{"id":null,"localeCode":null,"imageLabel":null,"altText":null,"imageUrl":null,"cmsId":null,"videoUrl":null,"mediaType":null,"sequence":null}]},"dynamicExpression":{"text":"string","tree":{"type":"string","logicalOperator":"string","nodes":[null],"left":"string","operator":"string","right":{}}},"productCount":0,"childCount":0,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"},"shouldSlice":true}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CategoryCollection |
post__commerce_catalog_admin_categories_ValidateDynamicExpression
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/categories/ValidateDynamicExpression \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/categories/ValidateDynamicExpression HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": null,
"logicalOperator": null,
"nodes": null,
"left": null,
"operator": null,
"right": null
}
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/categories/ValidateDynamicExpression',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/categories/ValidateDynamicExpression',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/categories/ValidateDynamicExpression', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/categories/ValidateDynamicExpression', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/categories/ValidateDynamicExpression");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/categories/ValidateDynamicExpression", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/categories/ValidateDynamicExpression
Body parameter
{
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": null,
"logicalOperator": null,
"nodes": null,
"left": null,
"operator": null,
"right": null
}
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | DynamicExpression | false | none |
Example responses
200 Response
{
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": null,
"logicalOperator": null,
"nodes": null,
"left": null,
"operator": null,
"right": null
}
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
}
{"text":"string","tree":{"type":"string","logicalOperator":"string","nodes":[{"type":"string","logicalOperator":"string","nodes":[{"type":null,"logicalOperator":null,"nodes":null,"left":null,"operator":null,"right":null}],"left":"string","operator":"string","right":{}}],"left":"string","operator":"string","right":{}}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DynamicExpression |
post__commerce_catalog_admin_categories_ValidateRealTimeDynamicExpression
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/categories/ValidateRealTimeDynamicExpression \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/categories/ValidateRealTimeDynamicExpression HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": null,
"logicalOperator": null,
"nodes": null,
"left": null,
"operator": null,
"right": null
}
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/categories/ValidateRealTimeDynamicExpression',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/categories/ValidateRealTimeDynamicExpression',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/categories/ValidateRealTimeDynamicExpression', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/categories/ValidateRealTimeDynamicExpression', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/categories/ValidateRealTimeDynamicExpression");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/categories/ValidateRealTimeDynamicExpression", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/categories/ValidateRealTimeDynamicExpression
Body parameter
{
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": null,
"logicalOperator": null,
"nodes": null,
"left": null,
"operator": null,
"right": null
}
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | DynamicExpression | false | none |
Example responses
200 Response
{
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": null,
"logicalOperator": null,
"nodes": null,
"left": null,
"operator": null,
"right": null
}
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
}
{"text":"string","tree":{"type":"string","logicalOperator":"string","nodes":[{"type":"string","logicalOperator":"string","nodes":[{"type":null,"logicalOperator":null,"nodes":null,"left":null,"operator":null,"right":null}],"left":"string","operator":"string","right":{}}],"left":"string","operator":"string","right":{}}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DynamicExpression |
post_commerce_catalog_admin_categories{categoryId}_remove-products
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/categories/{categoryId}/remove-products \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/categories/{categoryId}/remove-products HTTP/1.1
Content-Type: application/json
const inputBody = '[
"string"
]';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/categories/{categoryId}/remove-products',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/categories/{categoryId}/remove-products',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/categories/{categoryId}/remove-products', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/categories/{categoryId}/remove-products', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/categories/{categoryId}/remove-products");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/categories/{categoryId}/remove-products", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/categories/{categoryId}/remove-products
Removes the products in the provided product code list from the specified category.
Body parameter
[
"string"
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| categoryId | path | integer(int32) | true | Unique identifier of the category that you want products removed from. |
| body | body | array[string] | false | A list of products to be removed from the category. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
post_commerce_catalog_admin_categories{categoryId}_add-products
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/categories/{categoryId}/add-products \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/categories/{categoryId}/add-products HTTP/1.1
Content-Type: application/json
const inputBody = '[
"string"
]';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/categories/{categoryId}/add-products',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/categories/{categoryId}/add-products',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/categories/{categoryId}/add-products', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/categories/{categoryId}/add-products', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/categories/{categoryId}/add-products");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/categories/{categoryId}/add-products", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/categories/{categoryId}/add-products
Adds the products in the provided product code list to the specified category.
Body parameter
[
"string"
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| categoryId | path | integer(int32) | true | Unique identifier of the category that you want produts added to. |
| body | body | array[string] | false | A list of products to be added to the category. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
CoreFields
get__commerce_catalog_admin_corefields_search
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/corefields/search \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/corefields/search HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/corefields/search',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/corefields/search',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/corefields/search', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/corefields/search', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/corefields/search");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/corefields/search", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/corefields/search
Example responses
200 Response
{
"totalCount": 0,
"items": [
{
"fieldName": "string",
"label": "string",
"entityTpe": "string",
"dataType": "string"
}
]
}
{"totalCount":0,"items":[{"fieldName":"string","label":"string","entityTpe":"string","dataType":"string"}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CoreFieldCollection |
get__commerce_catalog_admin_corefields_search_product
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/corefields/search/product \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/corefields/search/product HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/corefields/search/product',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/corefields/search/product',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/corefields/search/product', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/corefields/search/product', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/corefields/search/product");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/corefields/search/product", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/corefields/search/product
Example responses
200 Response
{
"totalCount": 0,
"items": [
{
"fieldName": "string",
"label": "string",
"entityTpe": "string",
"dataType": "string"
}
]
}
{"totalCount":0,"items":[{"fieldName":"string","label":"string","entityTpe":"string","dataType":"string"}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CoreFieldCollection |
get__commerce_catalog_admin_corefields_search_category
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/corefields/search/category \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/corefields/search/category HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/corefields/search/category',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/corefields/search/category',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/corefields/search/category', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/corefields/search/category', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/corefields/search/category");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/corefields/search/category", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/corefields/search/category
Example responses
200 Response
{
"totalCount": 0,
"items": [
{
"fieldName": "string",
"label": "string",
"entityTpe": "string",
"dataType": "string"
}
]
}
{"totalCount":0,"items":[{"fieldName":"string","label":"string","entityTpe":"string","dataType":"string"}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CoreFieldCollection |
get__commerce_catalog_admin_corefields_search_boost
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/corefields/search/boost \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/corefields/search/boost HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/corefields/search/boost',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/corefields/search/boost',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/corefields/search/boost', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/corefields/search/boost', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/corefields/search/boost");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/corefields/search/boost", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/corefields/search/boost
Example responses
200 Response
{
"totalCount": 0,
"items": [
{
"fieldName": "string",
"label": "string",
"entityTpe": "string",
"dataType": "string"
}
]
}
{"totalCount":0,"items":[{"fieldName":"string","label":"string","entityTpe":"string","dataType":"string"}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CoreFieldCollection |
CouponSet
get__commerce_catalog_admin_couponsets_unique-code
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/couponsets/unique-code \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/couponsets/unique-code HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/couponsets/unique-code',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/couponsets/unique-code',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/couponsets/unique-code', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/couponsets/unique-code', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/couponsets/unique-code");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/couponsets/unique-code", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/couponsets/unique-code
Returns a random 4 character code that is unique as a coupon set code.
Example responses
200 Response
"string"
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
post__commerce_catalog_admin_couponsets_validate-unique-code
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/couponsets/validate-unique-code \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/couponsets/validate-unique-code HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/couponsets/validate-unique-code',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/couponsets/validate-unique-code',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/couponsets/validate-unique-code', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/couponsets/validate-unique-code', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/couponsets/validate-unique-code");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/couponsets/validate-unique-code", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/couponsets/validate-unique-code
Tests code for uniqueness and validity
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| code | query | string | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_couponsets{couponSetCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/couponsets/{couponSetCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/couponsets/{couponSetCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/couponsets/{couponSetCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/couponsets/{couponSetCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/couponsets/{couponSetCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/couponsets/{couponSetCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/couponsets/{couponSetCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/couponsets/{couponSetCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/couponsets/{couponSetCode}
Returns a single Mozu.ProductAdmin.Contracts.CouponSet
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| couponSetCode | path | string | true | CouponSetCode for the requested CouponSet |
| includeCounts | query | boolean | false | Include the redemption counts and coupon counts |
| responseGroups | query | string | false | "counts" includes the number of redemptions, coupon codes, and assigned discounts. |
Example responses
200 Response
{
"id": 0,
"couponSetCode": "string",
"name": "string",
"couponCodeType": "string",
"status": "string",
"canBeDeleted": true,
"maxRedemptionsPerUser": 0,
"maxRedemptionsPerCouponCode": 0,
"endDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"setSize": 0,
"couponCodeCount": 0,
"redemptionCount": 0,
"assignedDiscountCount": 0
}
{"id":0,"couponSetCode":"string","name":"string","couponCodeType":"string","status":"string","canBeDeleted":true,"maxRedemptionsPerUser":0,"maxRedemptionsPerCouponCode":0,"endDate":"2019-08-24T14:15:22Z","startDate":"2019-08-24T14:15:22Z","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"},"setSize":0,"couponCodeCount":0,"redemptionCount":0,"assignedDiscountCount":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CouponSet |
put_commerce_catalog_admin_couponsets{couponSetCode}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/couponsets/{couponSetCode} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/couponsets/{couponSetCode} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"id": 0,
"couponSetCode": "string",
"name": "string",
"couponCodeType": "string",
"status": "string",
"canBeDeleted": true,
"maxRedemptionsPerUser": 0,
"maxRedemptionsPerCouponCode": 0,
"endDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"setSize": 0,
"couponCodeCount": 0,
"redemptionCount": 0,
"assignedDiscountCount": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/couponsets/{couponSetCode}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/couponsets/{couponSetCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/couponsets/{couponSetCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/couponsets/{couponSetCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/couponsets/{couponSetCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/couponsets/{couponSetCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/couponsets/{couponSetCode}
Update a Mozu.ProductAdmin.Contracts.CouponSet representation. You can not update the Code or ID once the set is created.
Body parameter
{
"id": 0,
"couponSetCode": "string",
"name": "string",
"couponCodeType": "string",
"status": "string",
"canBeDeleted": true,
"maxRedemptionsPerUser": 0,
"maxRedemptionsPerCouponCode": 0,
"endDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"setSize": 0,
"couponCodeCount": 0,
"redemptionCount": 0,
"assignedDiscountCount": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| couponSetCode | path | string | true | none |
| body | body | CouponSet | false | none |
Example responses
200 Response
{
"id": 0,
"couponSetCode": "string",
"name": "string",
"couponCodeType": "string",
"status": "string",
"canBeDeleted": true,
"maxRedemptionsPerUser": 0,
"maxRedemptionsPerCouponCode": 0,
"endDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"setSize": 0,
"couponCodeCount": 0,
"redemptionCount": 0,
"assignedDiscountCount": 0
}
{"id":0,"couponSetCode":"string","name":"string","couponCodeType":"string","status":"string","canBeDeleted":true,"maxRedemptionsPerUser":0,"maxRedemptionsPerCouponCode":0,"endDate":"2019-08-24T14:15:22Z","startDate":"2019-08-24T14:15:22Z","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"},"setSize":0,"couponCodeCount":0,"redemptionCount":0,"assignedDiscountCount":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CouponSet |
delete_commerce_catalog_admin_couponsets{couponSetCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/couponsets/{couponSetCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/couponsets/{couponSetCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/couponsets/{couponSetCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/couponsets/{couponSetCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/couponsets/{couponSetCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/couponsets/{couponSetCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/couponsets/{couponSetCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/couponsets/{couponSetCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/couponsets/{couponSetCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| couponSetCode | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get__commerce_catalog_admin_couponsets
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/couponsets \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/couponsets HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/couponsets',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/couponsets',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/couponsets', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/couponsets', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/couponsets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/couponsets", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/couponsets
Returns a paged collection of CouponSets
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| startIndex | query | integer(int32) | false | none |
| pageSize | query | integer(int32) | false | none |
| sortBy | query | string | false | none |
| filter | query | string | false | none |
| includeCounts | query | boolean | false | Include coupon and redemption counts |
| responseGroups | query | string | false | "counts" returns discount and couponCode counts |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"id": 0,
"couponSetCode": "string",
"name": "string",
"couponCodeType": "string",
"status": "string",
"canBeDeleted": true,
"maxRedemptionsPerUser": 0,
"maxRedemptionsPerCouponCode": 0,
"endDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"setSize": 0,
"couponCodeCount": 0,
"redemptionCount": 0,
"assignedDiscountCount": 0
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"id":0,"couponSetCode":"string","name":"string","couponCodeType":"string","status":"string","canBeDeleted":true,"maxRedemptionsPerUser":0,"maxRedemptionsPerCouponCode":0,"endDate":"2019-08-24T14:15:22Z","startDate":"2019-08-24T14:15:22Z","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"},"setSize":0,"couponCodeCount":0,"redemptionCount":0,"assignedDiscountCount":0}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CouponSetCollection |
post__commerce_catalog_admin_couponsets
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/couponsets \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/couponsets HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"id": 0,
"couponSetCode": "string",
"name": "string",
"couponCodeType": "string",
"status": "string",
"canBeDeleted": true,
"maxRedemptionsPerUser": 0,
"maxRedemptionsPerCouponCode": 0,
"endDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"setSize": 0,
"couponCodeCount": 0,
"redemptionCount": 0,
"assignedDiscountCount": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/couponsets',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/couponsets',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/couponsets', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/couponsets', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/couponsets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/couponsets", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/couponsets
Adds a single Mozu.ProductAdmin.Contracts.CouponSet
Body parameter
{
"id": 0,
"couponSetCode": "string",
"name": "string",
"couponCodeType": "string",
"status": "string",
"canBeDeleted": true,
"maxRedemptionsPerUser": 0,
"maxRedemptionsPerCouponCode": 0,
"endDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"setSize": 0,
"couponCodeCount": 0,
"redemptionCount": 0,
"assignedDiscountCount": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CouponSet | false | none |
Example responses
200 Response
{
"id": 0,
"couponSetCode": "string",
"name": "string",
"couponCodeType": "string",
"status": "string",
"canBeDeleted": true,
"maxRedemptionsPerUser": 0,
"maxRedemptionsPerCouponCode": 0,
"endDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"setSize": 0,
"couponCodeCount": 0,
"redemptionCount": 0,
"assignedDiscountCount": 0
}
{"id":0,"couponSetCode":"string","name":"string","couponCodeType":"string","status":"string","canBeDeleted":true,"maxRedemptionsPerUser":0,"maxRedemptionsPerCouponCode":0,"endDate":"2019-08-24T14:15:22Z","startDate":"2019-08-24T14:15:22Z","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"},"setSize":0,"couponCodeCount":0,"redemptionCount":0,"assignedDiscountCount":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CouponSet |
get_commerce_catalog_admin_couponsets{couponSetCode}_couponcodes
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes
Returns a paged collection of Coupons
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| couponSetCode | path | string | true | none |
| startIndex | query | integer(int32) | false | none |
| pageSize | query | integer(int32) | false | none |
| sortBy | query | string | false | none |
| filter | query | string | false | none |
| includeCounts | query | boolean | false | Includes coupon redemption counts |
| responseGroups | query | string | false | counts |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"couponSetId": 0,
"couponSetCode": "string",
"couponCode": "string",
"canBeDeleted": true,
"redemptionCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"couponSetId":0,"couponSetCode":"string","couponCode":"string","canBeDeleted":true,"redemptionCount":0,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CouponCollection |
post_commerce_catalog_admin_couponsets{couponSetCode}_couponcodes
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes HTTP/1.1
Content-Type: application/json
const inputBody = '[
{
"couponSetId": 0,
"couponSetCode": "string",
"couponCode": "string",
"canBeDeleted": true,
"redemptionCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes
Body parameter
[
{
"couponSetId": 0,
"couponSetCode": "string",
"couponCode": "string",
"canBeDeleted": true,
"redemptionCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| couponSetCode | path | string | true | none |
| body | body | Coupon | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_couponsets{couponSetCode}couponcodes{couponCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| couponSetCode | path | string | true | none |
| couponCode | path | string | true | none |
| includeCounts | query | boolean | false | none |
| responseGroups | query | string | false | none |
Example responses
200 Response
{
"couponSetId": 0,
"couponSetCode": "string",
"couponCode": "string",
"canBeDeleted": true,
"redemptionCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"couponSetId":0,"couponSetCode":"string","couponCode":"string","canBeDeleted":true,"redemptionCount":0,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Coupon |
delete_commerce_catalog_admin_couponsets{couponSetCode}couponcodes{couponCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/{couponCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| couponSetCode | path | string | true | none |
| couponCode | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
post_commerce_catalog_admin_couponsets{couponSetCode}_couponcodes_remove
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/remove \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/remove HTTP/1.1
Content-Type: application/json
const inputBody = '[
"string"
]';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/remove',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/remove',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/remove', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/remove', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/remove");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/remove", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/couponsets/{couponSetCode}/couponcodes/remove
Body parameter
[
"string"
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| couponSetCode | path | string | true | none |
| body | body | array[string] | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_couponsets{couponSetCode}_assigneddiscounts
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| couponSetCode | path | string | true | none |
Example responses
200 Response
[
{
"couponSetCode": "string",
"couponSetId": 0,
"discountId": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
[{"couponSetCode":"string","couponSetId":0,"discountId":0,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [AssignedDiscount] | false | none | none |
| » couponSetCode | string¦null | false | none | ReadOnly, CouponSetCode copied from URI |
| » couponSetId | integer(int32) | false | none | ReadOnly, CouponSetId |
| » discountId | integer(int32) | true | none | Discount Id for the associated discount |
| » auditInfo | AuditInfo | false | none | none |
| »» updateDate | string(date-time)¦null | false | none | none |
| »» createDate | string(date-time)¦null | false | none | none |
| »» updateBy | string¦null | false | none | none |
| »» createBy | string¦null | false | none | none |
post_commerce_catalog_admin_couponsets{couponSetCode}_assigneddiscounts
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts HTTP/1.1
Content-Type: application/json
const inputBody = '{
"couponSetCode": "string",
"couponSetId": 0,
"discountId": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts
Body parameter
{
"couponSetCode": "string",
"couponSetId": 0,
"discountId": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| couponSetCode | path | string | true | none |
| body | body | AssignedDiscount | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
delete_commerce_catalog_admin_couponsets{couponSetCode}assigneddiscounts{discountId}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts/{discountId} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts/{discountId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts/{discountId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts/{discountId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts/{discountId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts/{discountId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts/{discountId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts/{discountId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts/{discountId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| couponSetCode | path | string | true | none |
| discountId | path | integer(int32) | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
Currency
post__commerce_catalog_admin_currency
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/currency \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/currency HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"currencyCode": "string",
"decimalPlaces": 0,
"roundingStrategy": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/currency',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/currency',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/currency', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/currency', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/currency");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/currency", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/currency
Adds a new product sort definition.
Body parameter
{
"currencyCode": "string",
"decimalPlaces": 0,
"roundingStrategy": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CurrencyLocalization | false | Properties of the currency-localization to create. |
Detailed descriptions
body: Properties of the currency-localization to create. Required properties: CurrencyCode
Example responses
200 Response
{
"currencyCode": "string",
"decimalPlaces": 0,
"roundingStrategy": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"currencyCode":"string","decimalPlaces":0,"roundingStrategy":0,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CurrencyLocalization |
get__commerce_catalog_admin_currency
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/currency \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/currency HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/currency',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/currency',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/currency', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/currency', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/currency");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/currency", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/currency
Gets all currency-localizations.
Example responses
200 Response
{
"totalCount": 0,
"items": [
{
"currencyCode": "string",
"decimalPlaces": 0,
"roundingStrategy": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
{"totalCount":0,"items":[{"currencyCode":"string","decimalPlaces":0,"roundingStrategy":0,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CurrencyLocalizationCollection |
delete_commerce_catalog_admin_currency{currencyCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/currency/{currencyCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/currency/{currencyCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/currency/{currencyCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/currency/{currencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/currency/{currencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/currency/{currencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/currency/{currencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/currency/{currencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/currency/{currencyCode}
Deletes the currency-localization specified by its currency code.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| currencyCode | path | string | true | Currency code. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_currency{currencyCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/currency/{currencyCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/currency/{currencyCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/currency/{currencyCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/currency/{currencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/currency/{currencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/currency/{currencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/currency/{currencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/currency/{currencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/currency/{currencyCode}
Gets a single currency-localization.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| currencyCode | path | string | true | Currency code. |
Example responses
200 Response
{
"currencyCode": "string",
"decimalPlaces": 0,
"roundingStrategy": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"currencyCode":"string","decimalPlaces":0,"roundingStrategy":0,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CurrencyLocalization |
put_commerce_catalog_admin_currency{currencyCode}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/currency/{currencyCode} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/currency/{currencyCode} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"currencyCode": "string",
"decimalPlaces": 0,
"roundingStrategy": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/currency/{currencyCode}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/currency/{currencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/currency/{currencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/currency/{currencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/currency/{currencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/currency/{currencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/currency/{currencyCode}
Updates the details of a currency-localization.
Body parameter
{
"currencyCode": "string",
"decimalPlaces": 0,
"roundingStrategy": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| currencyCode | path | string | true | Currency code. |
| body | body | CurrencyLocalization | false | Properties of the currency-localization to update. |
Example responses
200 Response
{
"currencyCode": "string",
"decimalPlaces": 0,
"roundingStrategy": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"currencyCode":"string","decimalPlaces":0,"roundingStrategy":0,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CurrencyLocalization |
post_commerce_catalog_admin_currency{currencyCode}_exchangerates
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/currency/{currencyCode}/exchangerates \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/currency/{currencyCode}/exchangerates HTTP/1.1
Content-Type: application/json
const inputBody = '[
{
"fromCurrencyCode": "string",
"toCurrencyCode": "string",
"rate": 0,
"multiplier": 0,
"referenceData": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/currency/{currencyCode}/exchangerates',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/currency/{currencyCode}/exchangerates',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/currency/{currencyCode}/exchangerates', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/currency/{currencyCode}/exchangerates', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/currency/{currencyCode}/exchangerates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/currency/{currencyCode}/exchangerates", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/currency/{currencyCode}/exchangerates
Add multiple exchange rates for a specified currency-code.
Body parameter
[
{
"fromCurrencyCode": "string",
"toCurrencyCode": "string",
"rate": 0,
"multiplier": 0,
"referenceData": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| currencyCode | path | string | true | Currency code |
| body | body | CurrencyExchangeRate | false | Exchange rates for the currency |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_currency{currencyCode}_exchangerates
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/currency/{currencyCode}/exchangerates \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/currency/{currencyCode}/exchangerates HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/currency/{currencyCode}/exchangerates',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/currency/{currencyCode}/exchangerates',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/currency/{currencyCode}/exchangerates', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/currency/{currencyCode}/exchangerates', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/currency/{currencyCode}/exchangerates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/currency/{currencyCode}/exchangerates", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/currency/{currencyCode}/exchangerates
Retrieves a list of exchange rates for a specified currency-code and filter criteria.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| currencyCode | path | string | true | Currency code |
Example responses
200 Response
{
"totalCount": 0,
"items": [
{
"fromCurrencyCode": "string",
"toCurrencyCode": "string",
"rate": 0,
"multiplier": 0,
"referenceData": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
{"totalCount":0,"items":[{"fromCurrencyCode":"string","toCurrencyCode":"string","rate":0,"multiplier":0,"referenceData":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CurrencyExchangeRateCollection |
put_commerce_catalog_admin_currency{currencyCode}_exchangerates
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/currency/{currencyCode}/exchangerates \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/currency/{currencyCode}/exchangerates HTTP/1.1
Content-Type: application/json
const inputBody = '[
{
"fromCurrencyCode": "string",
"toCurrencyCode": "string",
"rate": 0,
"multiplier": 0,
"referenceData": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/currency/{currencyCode}/exchangerates',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/currency/{currencyCode}/exchangerates',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/currency/{currencyCode}/exchangerates', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/currency/{currencyCode}/exchangerates', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/currency/{currencyCode}/exchangerates");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/currency/{currencyCode}/exchangerates", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/currency/{currencyCode}/exchangerates
Update multiple exchange rates for a specified currency-code.
Body parameter
[
{
"fromCurrencyCode": "string",
"toCurrencyCode": "string",
"rate": 0,
"multiplier": 0,
"referenceData": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| currencyCode | path | string | true | Currency code |
| body | body | CurrencyExchangeRate | false | Exchange rates for the currency |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
delete_commerce_catalog_admin_currency{currencyCode}exchangerates{toCurrencyCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode}
Delete a single exchange rate for a specified currency-code and target currency-code.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| currencyCode | path | string | true | Currency code |
| toCurrencyCode | path | string | true | C |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_currency{currencyCode}exchangerates{toCurrencyCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/currency/{currencyCode}/exchangerates/{toCurrencyCode}
Retrieves a single exchange rate for a specified currency-code and target-currency-code.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| currencyCode | path | string | true | Currency code |
| toCurrencyCode | path | string | true | Target currency code |
Example responses
200 Response
{
"fromCurrencyCode": "string",
"toCurrencyCode": "string",
"rate": 0,
"multiplier": 0,
"referenceData": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"fromCurrencyCode":"string","toCurrencyCode":"string","rate":0,"multiplier":0,"referenceData":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | CurrencyExchangeRate |
Discount
get__commerce_catalog_admin_discounts_generate-random-coupon
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/discounts/generate-random-coupon \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/discounts/generate-random-coupon HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/discounts/generate-random-coupon',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/discounts/generate-random-coupon',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/discounts/generate-random-coupon', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/discounts/generate-random-coupon', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/discounts/generate-random-coupon");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/discounts/generate-random-coupon", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/discounts/generate-random-coupon
Generates a random code for a coupon.
Example responses
200 Response
"string"
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | string |
get__commerce_catalog_admin_discounts
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/discounts \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/discounts HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/discounts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/discounts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/discounts', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/discounts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/discounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/discounts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/discounts
Retrieves a list of discounts according to any specified filter criteria and sort options.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| startIndex | query | integer(int32) | false | Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0. Optional. |
| pageSize | query | integer(int32) | false | Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200. Optional. |
| sortBy | query | string | false | The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional. |
| filter | query | string | false | A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional. |
| responseGroups | query | string | false | none |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": null
}
],
"excludedCategories": [
{
"categoryId": null
}
],
"includedProducts": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"customerSegments": [
{
"id": null
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": null
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": null
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": null
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": null
}
],
"products": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": null,
"name": null
}
],
"shippingZones": [
{
"zone": null
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"id":0,"content":{"localeCode":"string","name":"string","friendlyDescription":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"scope":"string","conditions":{"maxRedemptionCount":0,"requiresCoupon":true,"couponCode":"string","requiresAuthenticatedUser":true,"includedPaymentWorkflows":["string"],"includedCategories":[{"categoryId":null}],"excludedCategories":[{"categoryId":null}],"includedProducts":[{"productCode":null}],"excludedProducts":[{"productCode":null}],"customerSegments":[{"id":null}],"minimumQuantityRequiredProducts":0,"minimumQuantityProductsRequiredInCategories":0,"minimumOrderAmount":0,"maximumOrderAmount":0,"categoriesToExcludeFromMinOrderTotal":[{"categoryId":null}],"productsToExcludeFromMinOrderTotal":[{"productCode":null}],"minimumLifetimeValueAmount":0,"startDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","minimumCategorySubtotalBeforeDiscounts":0,"minimumRequiredQuantityPerRedemption":0},"target":{"type":"string","includeAllProducts":true,"includedCategoriesOperator":"string","categories":[{"id":null}],"excludedCategoriesOperator":"string","excludedCategories":[{"id":null}],"products":[{"productCode":null}],"excludedProducts":[{"productCode":null}],"excludeItemsWithExistingShippingDiscounts":true,"excludeItemsWithExistingProductDiscounts":true,"shippingMethods":[{"code":null,"name":null}],"shippingZones":[{"zone":null}],"maximumQuantityPerRedemption":0,"appliesToLeastExpensiveProductsFirst":true},"currentRedemptionCount":0,"amount":0,"amountType":"string","status":"string","canBeDeleted":true,"doesNotApplyToSalePrice":true,"doesNotApplyToProductsWithSalePrice":true,"maximumUsesPerUser":0,"maximumDiscountImpactPerOrder":0,"maximumDiscountImpactPerRedemption":0,"maximumRedemptionsPerOrder":0,"includedPriceLists":["string"],"doesNotApplyToMultiShipToOrders":true,"isBxGx":true,"canBeStackedUpon":true,"stackingLayer":0,"thresholdMessage":{"discountId":0,"thresholdValue":0,"isActive":true,"showInCart":true,"showOnCheckout":true,"requiresCouponCode":true,"content":{"localeCode":"string","messageTemplate":"string","auditInfo":{}},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"preventLineItemShippingDiscounts":true,"preventOrderProductDiscounts":true,"preventOrderShippingDiscounts":true,"hasPurchaseConditions":true,"purchaseRequirementType":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DiscountCollection |
post__commerce_catalog_admin_discounts
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/discounts \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/discounts HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": 0
}
],
"excludedCategories": [
{
"categoryId": 0
}
],
"includedProducts": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"customerSegments": [
{
"id": 0
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": 0
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": "string"
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": 0
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": 0
}
],
"products": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "string",
"name": "string"
}
],
"shippingZones": [
{
"zone": "string"
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/discounts',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/discounts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/discounts', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/discounts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/discounts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/discounts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/discounts
Creates a discount.
Body parameter
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": 0
}
],
"excludedCategories": [
{
"categoryId": 0
}
],
"includedProducts": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"customerSegments": [
{
"id": 0
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": 0
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": "string"
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": 0
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": 0
}
],
"products": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "string",
"name": "string"
}
],
"shippingZones": [
{
"zone": "string"
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Discount | false | Properties of the discount to create. Required properties: Content.Name, AmountType, StartDate, and Target.Type. |
Example responses
200 Response
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": 0
}
],
"excludedCategories": [
{
"categoryId": 0
}
],
"includedProducts": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"customerSegments": [
{
"id": 0
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": 0
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": "string"
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": 0
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": 0
}
],
"products": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "string",
"name": "string"
}
],
"shippingZones": [
{
"zone": "string"
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"id":0,"content":{"localeCode":"string","name":"string","friendlyDescription":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"scope":"string","conditions":{"maxRedemptionCount":0,"requiresCoupon":true,"couponCode":"string","requiresAuthenticatedUser":true,"includedPaymentWorkflows":["string"],"includedCategories":[{"categoryId":0}],"excludedCategories":[{"categoryId":0}],"includedProducts":[{"productCode":"string"}],"excludedProducts":[{"productCode":"string"}],"customerSegments":[{"id":0}],"minimumQuantityRequiredProducts":0,"minimumQuantityProductsRequiredInCategories":0,"minimumOrderAmount":0,"maximumOrderAmount":0,"categoriesToExcludeFromMinOrderTotal":[{"categoryId":0}],"productsToExcludeFromMinOrderTotal":[{"productCode":"string"}],"minimumLifetimeValueAmount":0,"startDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","minimumCategorySubtotalBeforeDiscounts":0,"minimumRequiredQuantityPerRedemption":0},"target":{"type":"string","includeAllProducts":true,"includedCategoriesOperator":"string","categories":[{"id":0}],"excludedCategoriesOperator":"string","excludedCategories":[{"id":0}],"products":[{"productCode":"string"}],"excludedProducts":[{"productCode":"string"}],"excludeItemsWithExistingShippingDiscounts":true,"excludeItemsWithExistingProductDiscounts":true,"shippingMethods":[{"code":"string","name":"string"}],"shippingZones":[{"zone":"string"}],"maximumQuantityPerRedemption":0,"appliesToLeastExpensiveProductsFirst":true},"currentRedemptionCount":0,"amount":0,"amountType":"string","status":"string","canBeDeleted":true,"doesNotApplyToSalePrice":true,"doesNotApplyToProductsWithSalePrice":true,"maximumUsesPerUser":0,"maximumDiscountImpactPerOrder":0,"maximumDiscountImpactPerRedemption":0,"maximumRedemptionsPerOrder":0,"includedPriceLists":["string"],"doesNotApplyToMultiShipToOrders":true,"isBxGx":true,"canBeStackedUpon":true,"stackingLayer":0,"thresholdMessage":{"discountId":0,"thresholdValue":0,"isActive":true,"showInCart":true,"showOnCheckout":true,"requiresCouponCode":true,"content":{"localeCode":"string","messageTemplate":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"preventLineItemShippingDiscounts":true,"preventOrderProductDiscounts":true,"preventOrderShippingDiscounts":true,"hasPurchaseConditions":true,"purchaseRequirementType":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Discount |
get_commerce_catalog_admin_discounts{discountId}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/discounts/{discountId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/discounts/{discountId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/discounts/{discountId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/discounts/{discountId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/discounts/{discountId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/discounts/{discountId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/discounts/{discountId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/discounts/{discountId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/discounts/{discountId}
Retrieves the details of a single discount.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| discountId | path | integer(int32) | true | Unique identifier of the discount. System-supplied and read-only. |
Example responses
200 Response
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": 0
}
],
"excludedCategories": [
{
"categoryId": 0
}
],
"includedProducts": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"customerSegments": [
{
"id": 0
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": 0
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": "string"
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": 0
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": 0
}
],
"products": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "string",
"name": "string"
}
],
"shippingZones": [
{
"zone": "string"
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"id":0,"content":{"localeCode":"string","name":"string","friendlyDescription":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"scope":"string","conditions":{"maxRedemptionCount":0,"requiresCoupon":true,"couponCode":"string","requiresAuthenticatedUser":true,"includedPaymentWorkflows":["string"],"includedCategories":[{"categoryId":0}],"excludedCategories":[{"categoryId":0}],"includedProducts":[{"productCode":"string"}],"excludedProducts":[{"productCode":"string"}],"customerSegments":[{"id":0}],"minimumQuantityRequiredProducts":0,"minimumQuantityProductsRequiredInCategories":0,"minimumOrderAmount":0,"maximumOrderAmount":0,"categoriesToExcludeFromMinOrderTotal":[{"categoryId":0}],"productsToExcludeFromMinOrderTotal":[{"productCode":"string"}],"minimumLifetimeValueAmount":0,"startDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","minimumCategorySubtotalBeforeDiscounts":0,"minimumRequiredQuantityPerRedemption":0},"target":{"type":"string","includeAllProducts":true,"includedCategoriesOperator":"string","categories":[{"id":0}],"excludedCategoriesOperator":"string","excludedCategories":[{"id":0}],"products":[{"productCode":"string"}],"excludedProducts":[{"productCode":"string"}],"excludeItemsWithExistingShippingDiscounts":true,"excludeItemsWithExistingProductDiscounts":true,"shippingMethods":[{"code":"string","name":"string"}],"shippingZones":[{"zone":"string"}],"maximumQuantityPerRedemption":0,"appliesToLeastExpensiveProductsFirst":true},"currentRedemptionCount":0,"amount":0,"amountType":"string","status":"string","canBeDeleted":true,"doesNotApplyToSalePrice":true,"doesNotApplyToProductsWithSalePrice":true,"maximumUsesPerUser":0,"maximumDiscountImpactPerOrder":0,"maximumDiscountImpactPerRedemption":0,"maximumRedemptionsPerOrder":0,"includedPriceLists":["string"],"doesNotApplyToMultiShipToOrders":true,"isBxGx":true,"canBeStackedUpon":true,"stackingLayer":0,"thresholdMessage":{"discountId":0,"thresholdValue":0,"isActive":true,"showInCart":true,"showOnCheckout":true,"requiresCouponCode":true,"content":{"localeCode":"string","messageTemplate":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"preventLineItemShippingDiscounts":true,"preventOrderProductDiscounts":true,"preventOrderShippingDiscounts":true,"hasPurchaseConditions":true,"purchaseRequirementType":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Discount |
put_commerce_catalog_admin_discounts{discountId}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/discounts/{discountId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/discounts/{discountId} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": 0
}
],
"excludedCategories": [
{
"categoryId": 0
}
],
"includedProducts": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"customerSegments": [
{
"id": 0
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": 0
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": "string"
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": 0
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": 0
}
],
"products": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "string",
"name": "string"
}
],
"shippingZones": [
{
"zone": "string"
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/discounts/{discountId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/discounts/{discountId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/discounts/{discountId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/discounts/{discountId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/discounts/{discountId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/discounts/{discountId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/discounts/{discountId}
Modifies a discount.
Body parameter
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": 0
}
],
"excludedCategories": [
{
"categoryId": 0
}
],
"includedProducts": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"customerSegments": [
{
"id": 0
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": 0
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": "string"
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": 0
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": 0
}
],
"products": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "string",
"name": "string"
}
],
"shippingZones": [
{
"zone": "string"
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| discountId | path | integer(int32) | true | Unique identifier of the discount. System-supplied and read-only. |
| body | body | Discount | false | Properties of the discount to update. |
Detailed descriptions
body: Properties of the discount to update. Required properties: Content.Name, AmountType, StartDate, and Target.Type. Any unspecified properties are set to null and boolean variables are set to false.
Example responses
200 Response
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": 0
}
],
"excludedCategories": [
{
"categoryId": 0
}
],
"includedProducts": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"customerSegments": [
{
"id": 0
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": 0
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": "string"
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": 0
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": 0
}
],
"products": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "string",
"name": "string"
}
],
"shippingZones": [
{
"zone": "string"
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"id":0,"content":{"localeCode":"string","name":"string","friendlyDescription":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"scope":"string","conditions":{"maxRedemptionCount":0,"requiresCoupon":true,"couponCode":"string","requiresAuthenticatedUser":true,"includedPaymentWorkflows":["string"],"includedCategories":[{"categoryId":0}],"excludedCategories":[{"categoryId":0}],"includedProducts":[{"productCode":"string"}],"excludedProducts":[{"productCode":"string"}],"customerSegments":[{"id":0}],"minimumQuantityRequiredProducts":0,"minimumQuantityProductsRequiredInCategories":0,"minimumOrderAmount":0,"maximumOrderAmount":0,"categoriesToExcludeFromMinOrderTotal":[{"categoryId":0}],"productsToExcludeFromMinOrderTotal":[{"productCode":"string"}],"minimumLifetimeValueAmount":0,"startDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","minimumCategorySubtotalBeforeDiscounts":0,"minimumRequiredQuantityPerRedemption":0},"target":{"type":"string","includeAllProducts":true,"includedCategoriesOperator":"string","categories":[{"id":0}],"excludedCategoriesOperator":"string","excludedCategories":[{"id":0}],"products":[{"productCode":"string"}],"excludedProducts":[{"productCode":"string"}],"excludeItemsWithExistingShippingDiscounts":true,"excludeItemsWithExistingProductDiscounts":true,"shippingMethods":[{"code":"string","name":"string"}],"shippingZones":[{"zone":"string"}],"maximumQuantityPerRedemption":0,"appliesToLeastExpensiveProductsFirst":true},"currentRedemptionCount":0,"amount":0,"amountType":"string","status":"string","canBeDeleted":true,"doesNotApplyToSalePrice":true,"doesNotApplyToProductsWithSalePrice":true,"maximumUsesPerUser":0,"maximumDiscountImpactPerOrder":0,"maximumDiscountImpactPerRedemption":0,"maximumRedemptionsPerOrder":0,"includedPriceLists":["string"],"doesNotApplyToMultiShipToOrders":true,"isBxGx":true,"canBeStackedUpon":true,"stackingLayer":0,"thresholdMessage":{"discountId":0,"thresholdValue":0,"isActive":true,"showInCart":true,"showOnCheckout":true,"requiresCouponCode":true,"content":{"localeCode":"string","messageTemplate":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"preventLineItemShippingDiscounts":true,"preventOrderProductDiscounts":true,"preventOrderShippingDiscounts":true,"hasPurchaseConditions":true,"purchaseRequirementType":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Discount |
delete_commerce_catalog_admin_discounts{discountId}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/discounts/{discountId} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/discounts/{discountId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/discounts/{discountId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/discounts/{discountId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/discounts/{discountId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/discounts/{discountId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/discounts/{discountId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/discounts/{discountId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/discounts/{discountId}
Deletes a discount specified by its discount ID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| discountId | path | integer(int32) | true | Unique identifier of the discount. System-supplied and read-only. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_discounts{discountId}_content
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/discounts/{discountId}/content \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/discounts/{discountId}/content HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/discounts/{discountId}/content',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/discounts/{discountId}/content',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/discounts/{discountId}/content', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/discounts/{discountId}/content', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/discounts/{discountId}/content");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/discounts/{discountId}/content", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/discounts/{discountId}/content
Retrieves the localized content specified for the specified discount.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| discountId | path | integer(int32) | true | Unique identifier of the discount. System-supplied and read-only. |
Example responses
200 Response
{
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"localeCode":"string","name":"string","friendlyDescription":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DiscountLocalizedContent |
put_commerce_catalog_admin_discounts{discountId}_content
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/discounts/{discountId}/content \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/discounts/{discountId}/content HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/discounts/{discountId}/content',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/discounts/{discountId}/content',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/discounts/{discountId}/content', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/discounts/{discountId}/content', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/discounts/{discountId}/content");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/discounts/{discountId}/content", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/discounts/{discountId}/content
Modifies the localized content for the specified discount. Allows you to rename the discount without modifying any other discount properties.
Body parameter
{
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| discountId | path | integer(int32) | true | Unique identifier of the discount. System-supplied and read-only. |
| body | body | DiscountLocalizedContent | false | New Name and/or LocaleCode. Properties of the content to update. Required property: Name. |
Example responses
200 Response
{
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"localeCode":"string","name":"string","friendlyDescription":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DiscountLocalizedContent |
get_commerce_catalog_admin_discounts{discountId}_target
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/discounts/{discountId}/target \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/discounts/{discountId}/target HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/discounts/{discountId}/target',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/discounts/{discountId}/target',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/discounts/{discountId}/target', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/discounts/{discountId}/target', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/discounts/{discountId}/target");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/discounts/{discountId}/target", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/discounts/{discountId}/target
Retrieves the discount target, that is which products, categories, or shipping methods are eligible for the discount.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| discountId | path | integer(int32) | true | Unique identifier of the discount. System-supplied and read-only. |
Example responses
200 Response
{
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": 0
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": 0
}
],
"products": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "string",
"name": "string"
}
],
"shippingZones": [
{
"zone": "string"
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
}
{"type":"string","includeAllProducts":true,"includedCategoriesOperator":"string","categories":[{"id":0}],"excludedCategoriesOperator":"string","excludedCategories":[{"id":0}],"products":[{"productCode":"string"}],"excludedProducts":[{"productCode":"string"}],"excludeItemsWithExistingShippingDiscounts":true,"excludeItemsWithExistingProductDiscounts":true,"shippingMethods":[{"code":"string","name":"string"}],"shippingZones":[{"zone":"string"}],"maximumQuantityPerRedemption":0,"appliesToLeastExpensiveProductsFirst":true}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DiscountTarget |
put_commerce_catalog_admin_discounts{discountId}_target
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/discounts/{discountId}/target \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/discounts/{discountId}/target HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": 0
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": 0
}
],
"products": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "string",
"name": "string"
}
],
"shippingZones": [
{
"zone": "string"
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/discounts/{discountId}/target',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/discounts/{discountId}/target',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/discounts/{discountId}/target', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/discounts/{discountId}/target', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/discounts/{discountId}/target");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/discounts/{discountId}/target", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/discounts/{discountId}/target
Modifies properties of the discount target, for example, the dollar amount, or precentage off the price.
Body parameter
{
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": 0
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": 0
}
],
"products": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "string",
"name": "string"
}
],
"shippingZones": [
{
"zone": "string"
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| discountId | path | integer(int32) | true | Unique identifier of the discount. System-supplied and read-only. |
| body | body | DiscountTarget | false | Properties of the discount target to modify. |
Detailed descriptions
body: Properties of the discount target to modify. Required properties: Target.Type. Any unspecified properties are set to null and boolean variables to false.
Example responses
200 Response
{
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": 0
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": 0
}
],
"products": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "string",
"name": "string"
}
],
"shippingZones": [
{
"zone": "string"
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
}
{"type":"string","includeAllProducts":true,"includedCategoriesOperator":"string","categories":[{"id":0}],"excludedCategoriesOperator":"string","excludedCategories":[{"id":0}],"products":[{"productCode":"string"}],"excludedProducts":[{"productCode":"string"}],"excludeItemsWithExistingShippingDiscounts":true,"excludeItemsWithExistingProductDiscounts":true,"shippingMethods":[{"code":"string","name":"string"}],"shippingZones":[{"zone":"string"}],"maximumQuantityPerRedemption":0,"appliesToLeastExpensiveProductsFirst":true}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DiscountTarget |
DiscountSettings
get_commerce_catalog_admin_discountsettings{catalogId}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/discountsettings/{catalogId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/discountsettings/{catalogId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/discountsettings/{catalogId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/discountsettings/{catalogId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/discountsettings/{catalogId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/discountsettings/{catalogId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/discountsettings/{catalogId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/discountsettings/{catalogId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/discountsettings/{catalogId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| catalogId | path | integer(int32) | true | none |
Example responses
200 Response
{
"stackingConfiguration": {
"stackingEnabled": true,
"productOrderLayers": 0,
"productLineItemLayers": 0
},
"usePostDiscountedOrderValue": true
}
{"stackingConfiguration":{"stackingEnabled":true,"productOrderLayers":0,"productLineItemLayers":0},"usePostDiscountedOrderValue":true}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DiscountSettings |
put_commerce_catalog_admin_discountsettings{catalogId}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/discountsettings/{catalogId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/discountsettings/{catalogId} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"stackingConfiguration": {
"stackingEnabled": true,
"productOrderLayers": 0,
"productLineItemLayers": 0
},
"usePostDiscountedOrderValue": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/discountsettings/{catalogId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/discountsettings/{catalogId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/discountsettings/{catalogId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/discountsettings/{catalogId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/discountsettings/{catalogId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/discountsettings/{catalogId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/discountsettings/{catalogId}
Body parameter
{
"stackingConfiguration": {
"stackingEnabled": true,
"productOrderLayers": 0,
"productLineItemLayers": 0
},
"usePostDiscountedOrderValue": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| catalogId | path | integer(int32) | true | none |
| body | body | DiscountSettings | false | none |
Example responses
200 Response
{
"stackingConfiguration": {
"stackingEnabled": true,
"productOrderLayers": 0,
"productLineItemLayers": 0
},
"usePostDiscountedOrderValue": true
}
{"stackingConfiguration":{"stackingEnabled":true,"productOrderLayers":0,"productLineItemLayers":0},"usePostDiscountedOrderValue":true}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | DiscountSettings |
Facet
get_commerce_catalog_admin_facets{facetId}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/facets/{facetId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/facets/{facetId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/facets/{facetId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/facets/{facetId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/facets/{facetId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/facets/{facetId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/facets/{facetId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/facets/{facetId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/facets/{facetId}
Retrieves the details of a Facet Definition
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| facetId | path | integer(int32) | true | none |
| validate | query | boolean | false | none |
Example responses
200 Response
{
"facetId": 0,
"source": {
"id": "string",
"type": "string",
"name": "string",
"dataType": "string",
"allowsRangeQuery": true
},
"facetType": "string",
"order": 0,
"categoryId": 0,
"valueSortType": "string",
"overrideFacetId": 0,
"isHidden": true,
"validity": {
"isValid": true,
"reasonCode": "string"
},
"rangeQueries": [
{
"rangeValueStart": {},
"rangeValueEnd": {}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"facetId":0,"source":{"id":"string","type":"string","name":"string","dataType":"string","allowsRangeQuery":true},"facetType":"string","order":0,"categoryId":0,"valueSortType":"string","overrideFacetId":0,"isHidden":true,"validity":{"isValid":true,"reasonCode":"string"},"rangeQueries":[{"rangeValueStart":{},"rangeValueEnd":{}}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Facet |
put_commerce_catalog_admin_facets{facetId}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/facets/{facetId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/facets/{facetId} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"facetId": 0,
"source": {
"id": "string",
"type": "string",
"name": "string",
"dataType": "string",
"allowsRangeQuery": true
},
"facetType": "string",
"order": 0,
"categoryId": 0,
"valueSortType": "string",
"overrideFacetId": 0,
"isHidden": true,
"validity": {
"isValid": true,
"reasonCode": "string"
},
"rangeQueries": [
{
"rangeValueStart": {},
"rangeValueEnd": {}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/facets/{facetId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/facets/{facetId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/facets/{facetId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/facets/{facetId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/facets/{facetId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/facets/{facetId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/facets/{facetId}
Modifies a Facet definition
Body parameter
{
"facetId": 0,
"source": {
"id": "string",
"type": "string",
"name": "string",
"dataType": "string",
"allowsRangeQuery": true
},
"facetType": "string",
"order": 0,
"categoryId": 0,
"valueSortType": "string",
"overrideFacetId": 0,
"isHidden": true,
"validity": {
"isValid": true,
"reasonCode": "string"
},
"rangeQueries": [
{
"rangeValueStart": {},
"rangeValueEnd": {}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| facetId | path | integer(int32) | true | none |
| body | body | Facet | false | none |
Example responses
200 Response
{
"facetId": 0,
"source": {
"id": "string",
"type": "string",
"name": "string",
"dataType": "string",
"allowsRangeQuery": true
},
"facetType": "string",
"order": 0,
"categoryId": 0,
"valueSortType": "string",
"overrideFacetId": 0,
"isHidden": true,
"validity": {
"isValid": true,
"reasonCode": "string"
},
"rangeQueries": [
{
"rangeValueStart": {},
"rangeValueEnd": {}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"facetId":0,"source":{"id":"string","type":"string","name":"string","dataType":"string","allowsRangeQuery":true},"facetType":"string","order":0,"categoryId":0,"valueSortType":"string","overrideFacetId":0,"isHidden":true,"validity":{"isValid":true,"reasonCode":"string"},"rangeQueries":[{"rangeValueStart":{},"rangeValueEnd":{}}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Facet |
delete_commerce_catalog_admin_facets{facetId}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/facets/{facetId} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/facets/{facetId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/facets/{facetId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/facets/{facetId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/facets/{facetId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/facets/{facetId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/facets/{facetId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/facets/{facetId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/facets/{facetId}
Deletes the Facet definition from the store
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| facetId | path | integer(int32) | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
post__commerce_catalog_admin_facets
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/facets \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/facets HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"facetId": 0,
"source": {
"id": "string",
"type": "string",
"name": "string",
"dataType": "string",
"allowsRangeQuery": true
},
"facetType": "string",
"order": 0,
"categoryId": 0,
"valueSortType": "string",
"overrideFacetId": 0,
"isHidden": true,
"validity": {
"isValid": true,
"reasonCode": "string"
},
"rangeQueries": [
{
"rangeValueStart": {},
"rangeValueEnd": {}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/facets',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/facets',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/facets', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/facets', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/facets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/facets", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/facets
Adds a new Facet to a category in a catalog.
Body parameter
{
"facetId": 0,
"source": {
"id": "string",
"type": "string",
"name": "string",
"dataType": "string",
"allowsRangeQuery": true
},
"facetType": "string",
"order": 0,
"categoryId": 0,
"valueSortType": "string",
"overrideFacetId": 0,
"isHidden": true,
"validity": {
"isValid": true,
"reasonCode": "string"
},
"rangeQueries": [
{
"rangeValueStart": {},
"rangeValueEnd": {}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Facet | false | none |
Example responses
200 Response
{
"facetId": 0,
"source": {
"id": "string",
"type": "string",
"name": "string",
"dataType": "string",
"allowsRangeQuery": true
},
"facetType": "string",
"order": 0,
"categoryId": 0,
"valueSortType": "string",
"overrideFacetId": 0,
"isHidden": true,
"validity": {
"isValid": true,
"reasonCode": "string"
},
"rangeQueries": [
{
"rangeValueStart": {},
"rangeValueEnd": {}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"facetId":0,"source":{"id":"string","type":"string","name":"string","dataType":"string","allowsRangeQuery":true},"facetType":"string","order":0,"categoryId":0,"valueSortType":"string","overrideFacetId":0,"isHidden":true,"validity":{"isValid":true,"reasonCode":"string"},"rangeQueries":[{"rangeValueStart":{},"rangeValueEnd":{}}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Facet |
get_commerce_catalog_admin_facets_category{categoryId}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/facets/category/{categoryId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/facets/category/{categoryId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/facets/category/{categoryId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/facets/category/{categoryId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/facets/category/{categoryId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/facets/category/{categoryId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/facets/category/{categoryId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/facets/category/{categoryId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/facets/category/{categoryId}
Retrieves a list of configured, and optionally available, Facet Configurations for the specified category
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| categoryId | path | integer(int32) | true | none |
| includeAvailable | query | boolean | false | none |
| validate | query | boolean | false | none |
Example responses
200 Response
{
"configured": [
{
"facetId": 0,
"source": {
"id": "string",
"type": "string",
"name": "string",
"dataType": "string",
"allowsRangeQuery": true
},
"facetType": "string",
"order": 0,
"categoryId": 0,
"valueSortType": "string",
"overrideFacetId": 0,
"isHidden": true,
"validity": {
"isValid": true,
"reasonCode": "string"
},
"rangeQueries": [
{
"rangeValueStart": {},
"rangeValueEnd": {}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"available": [
{
"id": "string",
"type": "string",
"name": "string",
"dataType": "string",
"allowsRangeQuery": true
}
]
}
{"configured":[{"facetId":0,"source":{"id":"string","type":"string","name":"string","dataType":"string","allowsRangeQuery":true},"facetType":"string","order":0,"categoryId":0,"valueSortType":"string","overrideFacetId":0,"isHidden":true,"validity":{"isValid":true,"reasonCode":"string"},"rangeQueries":[{"rangeValueStart":{},"rangeValueEnd":{}}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}],"available":[{"id":"string","type":"string","name":"string","dataType":"string","allowsRangeQuery":true}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | FacetSet |
LocationInventory
get_commerce_catalog_admin_locationinventory{locationCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/locationinventory/{locationCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/locationinventory/{locationCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/locationinventory/{locationCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/locationinventory/{locationCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/locationinventory/{locationCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/locationinventory/{locationCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/locationinventory/{locationCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/locationinventory/{locationCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/locationinventory/{locationCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| locationCode | path | string | true | none |
| startIndex | query | integer(int32) | false | none |
| pageSize | query | integer(int32) | false | none |
| sortBy | query | string | false | none |
| filter | query | string | false | none |
| filterFunctions | query | string | false | none |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"locationCode": "string",
"productCode": "string",
"productName": "string",
"stockOnHand": 0,
"stockAvailable": 0,
"stockOnBackOrder": 0,
"baseProductCode": "string",
"sku": "string",
"mfgPartNumber": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"locationCode":"string","productCode":"string","productName":"string","stockOnHand":0,"stockAvailable":0,"stockOnBackOrder":0,"baseProductCode":"string","sku":"string","mfgPartNumber":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | LocationInventoryCollection |
post_commerce_catalog_admin_locationinventory{locationCode}
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/locationinventory/{locationCode} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/locationinventory/{locationCode} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"locationCode": "string",
"productCode": "string",
"productName": "string",
"stockOnHand": 0,
"stockAvailable": 0,
"stockOnBackOrder": 0,
"baseProductCode": "string",
"sku": "string",
"mfgPartNumber": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/locationinventory/{locationCode}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/locationinventory/{locationCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/locationinventory/{locationCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/locationinventory/{locationCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/locationinventory/{locationCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/locationinventory/{locationCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/locationinventory/{locationCode}
Body parameter
[
{
"locationCode": "string",
"productCode": "string",
"productName": "string",
"stockOnHand": 0,
"stockAvailable": 0,
"stockOnBackOrder": 0,
"baseProductCode": "string",
"sku": "string",
"mfgPartNumber": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| locationCode | path | string | true | none |
| performUpserts | query | boolean | false | none |
| body | body | LocationInventory | false | none |
Example responses
200 Response
[
{
"locationCode": "string",
"productCode": "string",
"productName": "string",
"stockOnHand": 0,
"stockAvailable": 0,
"stockOnBackOrder": 0,
"baseProductCode": "string",
"sku": "string",
"mfgPartNumber": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
[{"locationCode":"string","productCode":"string","productName":"string","stockOnHand":0,"stockAvailable":0,"stockOnBackOrder":0,"baseProductCode":"string","sku":"string","mfgPartNumber":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [LocationInventory] | false | none | [The inventory for a product at a specific Location] |
| » locationCode | string¦null | false | none | none |
| » productCode | string¦null | false | none | none |
| » productName | string¦null | false | none | none |
| » stockOnHand | integer(int32)¦null | false | none | none |
| » stockAvailable | integer(int32)¦null | false | none | none |
| » stockOnBackOrder | integer(int32)¦null | false | none | none |
| » baseProductCode | string¦null | false | none | none |
| » sku | string¦null | false | none | none |
| » mfgPartNumber | string¦null | false | none | none |
| » auditInfo | AuditInfo | false | none | none |
| »» updateDate | string(date-time)¦null | false | none | none |
| »» createDate | string(date-time)¦null | false | none | none |
| »» updateBy | string¦null | false | none | none |
| »» createBy | string¦null | false | none | none |
put_commerce_catalog_admin_locationinventory{locationCode}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/locationinventory/{locationCode} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/locationinventory/{locationCode} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"productCode": "string",
"locationCode": "string",
"type": "string",
"value": 0
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/locationinventory/{locationCode}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/locationinventory/{locationCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/locationinventory/{locationCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/locationinventory/{locationCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/locationinventory/{locationCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/locationinventory/{locationCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/locationinventory/{locationCode}
Body parameter
[
{
"productCode": "string",
"locationCode": "string",
"type": "string",
"value": 0
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| locationCode | path | string | true | none |
| body | body | LocationInventoryAdjustment | false | none |
Example responses
200 Response
[
{
"locationCode": "string",
"productCode": "string",
"productName": "string",
"stockOnHand": 0,
"stockAvailable": 0,
"stockOnBackOrder": 0,
"baseProductCode": "string",
"sku": "string",
"mfgPartNumber": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
[{"locationCode":"string","productCode":"string","productName":"string","stockOnHand":0,"stockAvailable":0,"stockOnBackOrder":0,"baseProductCode":"string","sku":"string","mfgPartNumber":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [LocationInventory] | false | none | [The inventory for a product at a specific Location] |
| » locationCode | string¦null | false | none | none |
| » productCode | string¦null | false | none | none |
| » productName | string¦null | false | none | none |
| » stockOnHand | integer(int32)¦null | false | none | none |
| » stockAvailable | integer(int32)¦null | false | none | none |
| » stockOnBackOrder | integer(int32)¦null | false | none | none |
| » baseProductCode | string¦null | false | none | none |
| » sku | string¦null | false | none | none |
| » mfgPartNumber | string¦null | false | none | none |
| » auditInfo | AuditInfo | false | none | none |
| »» updateDate | string(date-time)¦null | false | none | none |
| »» createDate | string(date-time)¦null | false | none | none |
| »» updateBy | string¦null | false | none | none |
| »» createBy | string¦null | false | none | none |
get_commerce_catalog_admin_locationinventory{locationCode}_{productCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/locationinventory/{locationCode}/{productCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/locationinventory/{locationCode}/{productCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/locationinventory/{locationCode}/{productCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/locationinventory/{locationCode}/{productCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/locationinventory/{locationCode}/{productCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/locationinventory/{locationCode}/{productCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/locationinventory/{locationCode}/{productCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/locationinventory/{locationCode}/{productCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/locationinventory/{locationCode}/{productCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| locationCode | path | string | true | none |
| productCode | path | string | true | none |
Example responses
200 Response
{
"locationCode": "string",
"productCode": "string",
"productName": "string",
"stockOnHand": 0,
"stockAvailable": 0,
"stockOnBackOrder": 0,
"baseProductCode": "string",
"sku": "string",
"mfgPartNumber": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"locationCode":"string","productCode":"string","productName":"string","stockOnHand":0,"stockAvailable":0,"stockOnBackOrder":0,"baseProductCode":"string","sku":"string","mfgPartNumber":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | LocationInventory |
delete_commerce_catalog_admin_locationinventory{locationCode}_{productCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/locationinventory/{locationCode}/{productCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/locationinventory/{locationCode}/{productCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/locationinventory/{locationCode}/{productCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/locationinventory/{locationCode}/{productCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/locationinventory/{locationCode}/{productCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/locationinventory/{locationCode}/{productCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/locationinventory/{locationCode}/{productCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/locationinventory/{locationCode}/{productCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/locationinventory/{locationCode}/{productCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| locationCode | path | string | true | none |
| productCode | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
MasterCatalog
get__commerce_catalog_admin_mastercatalogs
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/mastercatalogs \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/mastercatalogs HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/mastercatalogs',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/mastercatalogs',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/mastercatalogs', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/mastercatalogs', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/mastercatalogs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/mastercatalogs", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/mastercatalogs
Example responses
200 Response
{
"totalCount": 0,
"items": [
{
"id": 0,
"name": "string",
"productPublishingMode": "string",
"enableLiveEdit": true,
"isDeleted": true
}
]
}
{"totalCount":0,"items":[{"id":0,"name":"string","productPublishingMode":"string","enableLiveEdit":true,"isDeleted":true}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | MasterCatalogCollection |
get_commerce_catalog_admin_mastercatalogs{masterCatalogId}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/mastercatalogs/{masterCatalogId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/mastercatalogs/{masterCatalogId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/mastercatalogs/{masterCatalogId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/mastercatalogs/{masterCatalogId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/mastercatalogs/{masterCatalogId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/mastercatalogs/{masterCatalogId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/mastercatalogs/{masterCatalogId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/mastercatalogs/{masterCatalogId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/mastercatalogs/{masterCatalogId}
Get a MasterCatalog
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| masterCatalogId | path | integer(int32) | true | none |
Example responses
200 Response
{
"id": 0,
"name": "string",
"productPublishingMode": "string",
"enableLiveEdit": true,
"isDeleted": true
}
{"id":0,"name":"string","productPublishingMode":"string","enableLiveEdit":true,"isDeleted":true}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | MasterCatalog |
put_commerce_catalog_admin_mastercatalogs{masterCatalogId}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/mastercatalogs/{masterCatalogId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/mastercatalogs/{masterCatalogId} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"id": 0,
"name": "string",
"productPublishingMode": "string",
"enableLiveEdit": true,
"isDeleted": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/mastercatalogs/{masterCatalogId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/mastercatalogs/{masterCatalogId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/mastercatalogs/{masterCatalogId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/mastercatalogs/{masterCatalogId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/mastercatalogs/{masterCatalogId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/mastercatalogs/{masterCatalogId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/mastercatalogs/{masterCatalogId}
Update the publishingMode of a MasterCatalog
Body parameter
{
"id": 0,
"name": "string",
"productPublishingMode": "string",
"enableLiveEdit": true,
"isDeleted": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| masterCatalogId | path | integer(int32) | true | none |
| body | body | MasterCatalog | false | none |
Example responses
200 Response
{
"id": 0,
"name": "string",
"productPublishingMode": "string",
"enableLiveEdit": true,
"isDeleted": true
}
{"id":0,"name":"string","productPublishingMode":"string","enableLiveEdit":true,"isDeleted":true}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | MasterCatalog |
PriceList
get__commerce_catalog_admin_pricelists
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/pricelists \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/pricelists HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/pricelists',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/pricelists',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/pricelists', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/pricelists', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/pricelists");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/pricelists", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/pricelists
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| startIndex | query | integer(int32) | false | none |
| pageSize | query | integer(int32) | false | none |
| sortBy | query | string | false | none |
| filter | query | string | false | none |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"priceListCode": "string",
"priceListSequence": 0,
"parentPriceListCode": "string",
"parentPriceListName": "string",
"name": "string",
"description": "string",
"enabled": true,
"filteredInStorefront": true,
"validForAllSites": true,
"validSites": [
0
],
"defaultForSites": [
0
],
"indexedSites": [
0
],
"mappedCustomerSegments": [
"string"
],
"rank": 0,
"resolvable": true,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"priceListCode":"string","priceListSequence":0,"parentPriceListCode":"string","parentPriceListName":"string","name":"string","description":"string","enabled":true,"filteredInStorefront":true,"validForAllSites":true,"validSites":[0],"defaultForSites":[0],"indexedSites":[0],"mappedCustomerSegments":["string"],"rank":0,"resolvable":true,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PriceListCollection |
post__commerce_catalog_admin_pricelists
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/pricelists \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/pricelists HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"priceListCode": "string",
"priceListSequence": 0,
"parentPriceListCode": "string",
"parentPriceListName": "string",
"name": "string",
"description": "string",
"enabled": true,
"filteredInStorefront": true,
"validForAllSites": true,
"validSites": [
0
],
"defaultForSites": [
0
],
"indexedSites": [
0
],
"mappedCustomerSegments": [
"string"
],
"rank": 0,
"resolvable": true,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/pricelists',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/pricelists',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/pricelists', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/pricelists', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/pricelists");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/pricelists", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/pricelists
Body parameter
{
"priceListCode": "string",
"priceListSequence": 0,
"parentPriceListCode": "string",
"parentPriceListName": "string",
"name": "string",
"description": "string",
"enabled": true,
"filteredInStorefront": true,
"validForAllSites": true,
"validSites": [
0
],
"defaultForSites": [
0
],
"indexedSites": [
0
],
"mappedCustomerSegments": [
"string"
],
"rank": 0,
"resolvable": true,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PriceList | false | none |
Example responses
200 Response
{
"priceListCode": "string",
"priceListSequence": 0,
"parentPriceListCode": "string",
"parentPriceListName": "string",
"name": "string",
"description": "string",
"enabled": true,
"filteredInStorefront": true,
"validForAllSites": true,
"validSites": [
0
],
"defaultForSites": [
0
],
"indexedSites": [
0
],
"mappedCustomerSegments": [
"string"
],
"rank": 0,
"resolvable": true,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"priceListCode":"string","priceListSequence":0,"parentPriceListCode":"string","parentPriceListName":"string","name":"string","description":"string","enabled":true,"filteredInStorefront":true,"validForAllSites":true,"validSites":[0],"defaultForSites":[0],"indexedSites":[0],"mappedCustomerSegments":["string"],"rank":0,"resolvable":true,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PriceList |
get_commerce_catalog_admin_pricelists{priceListCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/pricelists/{priceListCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/pricelists/{priceListCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/pricelists/{priceListCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/pricelists/{priceListCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/pricelists/{priceListCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/pricelists/{priceListCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/pricelists/{priceListCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/pricelists/{priceListCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/pricelists/{priceListCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| priceListCode | path | string | true | none |
Example responses
200 Response
{
"priceListCode": "string",
"priceListSequence": 0,
"parentPriceListCode": "string",
"parentPriceListName": "string",
"name": "string",
"description": "string",
"enabled": true,
"filteredInStorefront": true,
"validForAllSites": true,
"validSites": [
0
],
"defaultForSites": [
0
],
"indexedSites": [
0
],
"mappedCustomerSegments": [
"string"
],
"rank": 0,
"resolvable": true,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"priceListCode":"string","priceListSequence":0,"parentPriceListCode":"string","parentPriceListName":"string","name":"string","description":"string","enabled":true,"filteredInStorefront":true,"validForAllSites":true,"validSites":[0],"defaultForSites":[0],"indexedSites":[0],"mappedCustomerSegments":["string"],"rank":0,"resolvable":true,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PriceList |
put_commerce_catalog_admin_pricelists{priceListCode}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/pricelists/{priceListCode} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/pricelists/{priceListCode} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"priceListCode": "string",
"priceListSequence": 0,
"parentPriceListCode": "string",
"parentPriceListName": "string",
"name": "string",
"description": "string",
"enabled": true,
"filteredInStorefront": true,
"validForAllSites": true,
"validSites": [
0
],
"defaultForSites": [
0
],
"indexedSites": [
0
],
"mappedCustomerSegments": [
"string"
],
"rank": 0,
"resolvable": true,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/pricelists/{priceListCode}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/pricelists/{priceListCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/pricelists/{priceListCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/pricelists/{priceListCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/pricelists/{priceListCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/pricelists/{priceListCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/pricelists/{priceListCode}
Body parameter
{
"priceListCode": "string",
"priceListSequence": 0,
"parentPriceListCode": "string",
"parentPriceListName": "string",
"name": "string",
"description": "string",
"enabled": true,
"filteredInStorefront": true,
"validForAllSites": true,
"validSites": [
0
],
"defaultForSites": [
0
],
"indexedSites": [
0
],
"mappedCustomerSegments": [
"string"
],
"rank": 0,
"resolvable": true,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| priceListCode | path | string | true | none |
| body | body | PriceList | false | none |
Example responses
200 Response
{
"priceListCode": "string",
"priceListSequence": 0,
"parentPriceListCode": "string",
"parentPriceListName": "string",
"name": "string",
"description": "string",
"enabled": true,
"filteredInStorefront": true,
"validForAllSites": true,
"validSites": [
0
],
"defaultForSites": [
0
],
"indexedSites": [
0
],
"mappedCustomerSegments": [
"string"
],
"rank": 0,
"resolvable": true,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"priceListCode":"string","priceListSequence":0,"parentPriceListCode":"string","parentPriceListName":"string","name":"string","description":"string","enabled":true,"filteredInStorefront":true,"validForAllSites":true,"validSites":[0],"defaultForSites":[0],"indexedSites":[0],"mappedCustomerSegments":["string"],"rank":0,"resolvable":true,"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PriceList |
delete_commerce_catalog_admin_pricelists{priceListCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/pricelists/{priceListCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/pricelists/{priceListCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/pricelists/{priceListCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/pricelists/{priceListCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/pricelists/{priceListCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/pricelists/{priceListCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/pricelists/{priceListCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/pricelists/{priceListCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/pricelists/{priceListCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| priceListCode | path | string | true | none |
| cascadeDeleteEntries | query | boolean | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_pricelists{priceListCode}_entries
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/pricelists/{priceListCode}/entries \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/pricelists/{priceListCode}/entries HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/pricelists/{priceListCode}/entries',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/pricelists/{priceListCode}/entries',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/pricelists/{priceListCode}/entries', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/pricelists/{priceListCode}/entries', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/pricelists/{priceListCode}/entries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/pricelists/{priceListCode}/entries", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/pricelists/{priceListCode}/entries
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| priceListCode | path | string | true | none |
| startIndex | query | integer(int32) | false | none |
| pageSize | query | integer(int32) | false | none |
| sortBy | query | string | false | none |
| filter | query | string | false | none |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"priceListCode":"string","priceListEntrySequence":0,"productCode":"string","productName":"string","isVariation":true,"options":[{"attributeFQN":"string","isProductImageGroupSelector":true,"values":[{}]}],"currencyCode":"string","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","priceListEntryMode":"string","priceListEntryTypeCode":"string","discountsRestrictedMode":"string","discountsRestricted":true,"discountsRestrictedStartDate":"2019-08-24T14:15:22Z","discountsRestrictedEndDate":"2019-08-24T14:15:22Z","msrpMode":"string","msrp":0,"mapMode":"string","map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","costMode":"string","cost":0,"priceEntries":[{"minQty":0,"listPriceMode":"string","listPrice":0,"salePriceMode":"string","salePrice":0}],"extraEntries":[{"attributeFQN":"string","value":{},"price":0,"attributeCode":"string","attributeName":"string","displayValue":"string"}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PriceListEntryCollection |
post_commerce_catalog_admin_pricelists{priceListCode}_entries
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/pricelists/{priceListCode}/entries \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/pricelists/{priceListCode}/entries HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/pricelists/{priceListCode}/entries',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/pricelists/{priceListCode}/entries',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/pricelists/{priceListCode}/entries', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/pricelists/{priceListCode}/entries', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/pricelists/{priceListCode}/entries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/pricelists/{priceListCode}/entries", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/pricelists/{priceListCode}/entries
Body parameter
{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| priceListCode | path | string | true | none |
| body | body | PriceListEntry | false | none |
Example responses
200 Response
{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"priceListCode":"string","priceListEntrySequence":0,"productCode":"string","productName":"string","isVariation":true,"options":[{"attributeFQN":"string","isProductImageGroupSelector":true,"values":[{"value":{},"attributeVocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}]}],"currencyCode":"string","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","priceListEntryMode":"string","priceListEntryTypeCode":"string","discountsRestrictedMode":"string","discountsRestricted":true,"discountsRestrictedStartDate":"2019-08-24T14:15:22Z","discountsRestrictedEndDate":"2019-08-24T14:15:22Z","msrpMode":"string","msrp":0,"mapMode":"string","map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","costMode":"string","cost":0,"priceEntries":[{"minQty":0,"listPriceMode":"string","listPrice":0,"salePriceMode":"string","salePrice":0}],"extraEntries":[{"attributeFQN":"string","value":{},"price":0,"attributeCode":"string","attributeName":"string","displayValue":"string"}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PriceListEntry |
get_commerce_catalog_admin_pricelists{priceListCode}entries{productCode}_{currencyCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| priceListCode | path | string | true | none |
| productCode | path | string | true | none |
| currencyCode | path | string | true | none |
| startDate | query | string(date-time) | false | none |
Example responses
200 Response
{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"priceListCode":"string","priceListEntrySequence":0,"productCode":"string","productName":"string","isVariation":true,"options":[{"attributeFQN":"string","isProductImageGroupSelector":true,"values":[{"value":{},"attributeVocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}]}],"currencyCode":"string","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","priceListEntryMode":"string","priceListEntryTypeCode":"string","discountsRestrictedMode":"string","discountsRestricted":true,"discountsRestrictedStartDate":"2019-08-24T14:15:22Z","discountsRestrictedEndDate":"2019-08-24T14:15:22Z","msrpMode":"string","msrp":0,"mapMode":"string","map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","costMode":"string","cost":0,"priceEntries":[{"minQty":0,"listPriceMode":"string","listPrice":0,"salePriceMode":"string","salePrice":0}],"extraEntries":[{"attributeFQN":"string","value":{},"price":0,"attributeCode":"string","attributeName":"string","displayValue":"string"}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PriceListEntry |
put_commerce_catalog_admin_pricelists{priceListCode}entries{productCode}_{currencyCode}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}
Body parameter
{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| priceListCode | path | string | true | none |
| productCode | path | string | true | none |
| currencyCode | path | string | true | none |
| startDate | query | string(date-time) | false | none |
| body | body | PriceListEntry | false | none |
Example responses
200 Response
{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"priceListCode":"string","priceListEntrySequence":0,"productCode":"string","productName":"string","isVariation":true,"options":[{"attributeFQN":"string","isProductImageGroupSelector":true,"values":[{"value":{},"attributeVocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}]}],"currencyCode":"string","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","priceListEntryMode":"string","priceListEntryTypeCode":"string","discountsRestrictedMode":"string","discountsRestricted":true,"discountsRestrictedStartDate":"2019-08-24T14:15:22Z","discountsRestrictedEndDate":"2019-08-24T14:15:22Z","msrpMode":"string","msrp":0,"mapMode":"string","map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","costMode":"string","cost":0,"priceEntries":[{"minQty":0,"listPriceMode":"string","listPrice":0,"salePriceMode":"string","salePrice":0}],"extraEntries":[{"attributeFQN":"string","value":{},"price":0,"attributeCode":"string","attributeName":"string","displayValue":"string"}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PriceListEntry |
delete_commerce_catalog_admin_pricelists{priceListCode}entries{productCode}_{currencyCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/pricelists/{priceListCode}/entries/{productCode}/{currencyCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| priceListCode | path | string | true | none |
| productCode | path | string | true | none |
| currencyCode | path | string | true | none |
| startDate | query | string(date-time) | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
post__commerce_catalog_admin_pricelists_bulkaddentries
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/pricelists/bulkaddentries \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/pricelists/bulkaddentries HTTP/1.1
Content-Type: application/json
const inputBody = '[
{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {}
}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/pricelists/bulkaddentries',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/pricelists/bulkaddentries',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/pricelists/bulkaddentries', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/pricelists/bulkaddentries', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/pricelists/bulkaddentries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/pricelists/bulkaddentries", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/pricelists/bulkaddentries
Body parameter
[
{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {}
}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| publishEvents | query | boolean | false | none |
| invalidateCache | query | boolean | false | none |
| body | body | PriceListEntry | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
post__commerce_catalog_admin_pricelists_bulkupdateentries
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/pricelists/bulkupdateentries \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/pricelists/bulkupdateentries HTTP/1.1
Content-Type: application/json
const inputBody = '[
{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {}
}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/pricelists/bulkupdateentries',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/pricelists/bulkupdateentries',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/pricelists/bulkupdateentries', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/pricelists/bulkupdateentries', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/pricelists/bulkupdateentries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/pricelists/bulkupdateentries", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/pricelists/bulkupdateentries
Body parameter
[
{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {}
}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| publishEvents | query | boolean | false | none |
| invalidateCache | query | boolean | false | none |
| body | body | PriceListEntry | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
post__commerce_catalog_admin_pricelists_bulkdeleteentries
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/pricelists/bulkdeleteentries \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/pricelists/bulkdeleteentries HTTP/1.1
Content-Type: application/json
const inputBody = '[
{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {}
}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/pricelists/bulkdeleteentries',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/pricelists/bulkdeleteentries',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/pricelists/bulkdeleteentries', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/pricelists/bulkdeleteentries', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/pricelists/bulkdeleteentries");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/pricelists/bulkdeleteentries", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/pricelists/bulkdeleteentries
Body parameter
[
{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {}
}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| publishEvents | query | boolean | false | none |
| invalidateCache | query | boolean | false | none |
| body | body | PriceListEntry | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
Product
get__commerce_catalog_admin_products
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products
Retrieves a list of products according to any specified filter criteria and sort options.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| startIndex | query | integer(int32) | false | Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0. |
| pageSize | query | integer(int32) | false | Used to page results from a query. Indicates the maximum number of entities to return from a single query. The default value is 20 and the maximum value is 200. |
| sortBy | query | string | false | The element to sort the results by and the order in which the results appear. Either ascending or descending order. For example, to sort the results by “ID” ascending then by “CreateDate” descending, use: id asc,createdate desc. |
| responseGroups | query | string | false | Used to get more specific information from the request. For example to get discounts applied to a product use the AppliedProducts response group. Available response groups: ApplicableDiscounts, VariationOptions, and BaseProductCode. |
| filter | query | string | false | A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional. |
| q | query | string | false | none |
| qLimit | query | integer(int32) | false | none |
| noCount | query | boolean | false | none |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"productCode": "string",
"productUsage": "string",
"fulfillmentTypesSupported": [
"string"
],
"masterCatalogId": 0,
"productSequence": 0,
"productTypeId": 0,
"isValidForProductType": true,
"baseProductCode": "string",
"productInCatalogs": [
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": null,
"productName": null,
"productFullDescription": null,
"productShortDescription": null,
"productImages": null
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": null,
"price": null,
"salePrice": null,
"msrp": null,
"map": null,
"mapStartDate": null,
"mapEndDate": null,
"creditValue": null
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": null,
"metaTagTitle": null,
"metaTagDescription": null,
"metaTagKeywords": null,
"titleTagTitle": null,
"seoFriendlyUrl": null
},
"productCategories": [
{}
],
"primaryProductCategory": {
"categoryId": null
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": null,
"endDate": null
},
"auditInfo": {
"updateDate": null,
"createDate": null,
"updateBy": null,
"createBy": null
}
}
],
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": null,
"localeCode": null,
"imageLabel": null,
"altText": null,
"imageUrl": null,
"cmsId": null,
"videoUrl": null,
"mediaType": null,
"sequence": null,
"productImageGroupId": null
}
]
},
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"variationPricingMethod": "string"
},
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{}
]
}
],
"extras": [
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{}
]
}
],
"properties": [
{
"attributeFQN": "string",
"values": [
{}
]
}
],
"isTaxable": true,
"inventoryInfo": {
"manageStock": true,
"outOfStockBehavior": "string"
},
"shippingClassId": 0,
"isRecurring": true,
"upc": "string",
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
},
"isPackagedStandAlone": true,
"standAlonePackageType": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"applicableDiscounts": [
{
"id": 0,
"content": {
"localeCode": null,
"name": null,
"friendlyDescription": null,
"auditInfo": null
},
"scope": "string",
"conditions": {
"maxRedemptionCount": null,
"requiresCoupon": null,
"couponCode": null,
"requiresAuthenticatedUser": null,
"includedPaymentWorkflows": null,
"includedCategories": null,
"excludedCategories": null,
"includedProducts": null,
"excludedProducts": null,
"customerSegments": null,
"minimumQuantityRequiredProducts": null,
"minimumQuantityProductsRequiredInCategories": null,
"minimumOrderAmount": null,
"maximumOrderAmount": null,
"categoriesToExcludeFromMinOrderTotal": null,
"productsToExcludeFromMinOrderTotal": null,
"minimumLifetimeValueAmount": null,
"startDate": null,
"expirationDate": null,
"minimumCategorySubtotalBeforeDiscounts": null,
"minimumRequiredQuantityPerRedemption": null
},
"target": {
"type": null,
"includeAllProducts": null,
"includedCategoriesOperator": null,
"categories": null,
"excludedCategoriesOperator": null,
"excludedCategories": null,
"products": null,
"excludedProducts": null,
"excludeItemsWithExistingShippingDiscounts": null,
"excludeItemsWithExistingProductDiscounts": null,
"shippingMethods": null,
"shippingZones": null,
"maximumQuantityPerRedemption": null,
"appliesToLeastExpensiveProductsFirst": null
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": null,
"thresholdValue": null,
"isActive": null,
"showInCart": null,
"showOnCheckout": null,
"requiresCouponCode": null,
"content": null,
"auditInfo": null
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": null,
"createDate": null,
"updateBy": null,
"createBy": null
}
}
],
"isVariation": true,
"variationKey": "string",
"hasConfigurableOptions": true,
"hasStandAloneOptions": true,
"variationOptions": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": null,
"stringValue": null
}
}
],
"publishingInfo": {
"publishedState": "string",
"lastPublishedBy": "string",
"lastPublishedDate": "2019-08-24T14:15:22Z",
"publishSetCode": "string"
},
"bundledProducts": [
{
"productCode": "string",
"quantity": 0,
"price": {
"isoCurrencyCode": null,
"price": null,
"salePrice": null,
"msrp": null,
"map": null,
"mapStartDate": null,
"mapEndDate": null,
"creditValue": null
},
"productName": "string",
"packageHeight": {
"unit": null,
"value": null
},
"packageWidth": {
"unit": null,
"value": null
},
"packageLength": {
"unit": null,
"value": null
},
"packageWeight": {
"unit": null,
"value": null
},
"fulfillmentTypesSupported": [
"string"
]
}
],
"productImageGroups": [
{
"productImageGroupId": "string",
"productImageGroupTags": [
{}
]
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"slicingSettings": {
"slicingAttributeFqn": "string"
}
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"productCode":"string","productUsage":"string","fulfillmentTypesSupported":["string"],"masterCatalogId":0,"productSequence":0,"productTypeId":0,"isValidForProductType":true,"baseProductCode":"string","productInCatalogs":[{"catalogId":0,"isActive":true,"isContentOverridden":true,"content":{"localeCode":null,"productName":null,"productFullDescription":null,"productShortDescription":null,"productImages":null},"isPriceOverridden":true,"price":{"isoCurrencyCode":null,"price":null,"salePrice":null,"msrp":null,"map":null,"mapStartDate":null,"mapEndDate":null,"creditValue":null},"isSeoContentOverridden":true,"seoContent":{"localeCode":null,"metaTagTitle":null,"metaTagDescription":null,"metaTagKeywords":null,"titleTagTitle":null,"seoFriendlyUrl":null},"productCategories":[{}],"primaryProductCategory":{"categoryId":null},"dateFirstAvailableInCatalog":"2019-08-24T14:15:22Z","activeDateRange":{"startDate":null,"endDate":null},"auditInfo":{"updateDate":null,"createDate":null,"updateBy":null,"createBy":null}}],"content":{"localeCode":"string","productName":"string","productFullDescription":"string","productShortDescription":"string","productImages":[{"id":null,"localeCode":null,"imageLabel":null,"altText":null,"imageUrl":null,"cmsId":null,"videoUrl":null,"mediaType":null,"sequence":null,"productImageGroupId":null}]},"price":{"isoCurrencyCode":"string","price":0,"salePrice":0,"msrp":0,"map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","creditValue":0},"pricingBehavior":{"discountsRestricted":true,"discountsRestrictedStartDate":"2019-08-24T14:15:22Z","discountsRestrictedEndDate":"2019-08-24T14:15:22Z","variationPricingMethod":"string"},"seoContent":{"localeCode":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","titleTagTitle":"string","seoFriendlyUrl":"string"},"options":[{"attributeFQN":"string","isProductImageGroupSelector":true,"values":[{}]}],"extras":[{"attributeFQN":"string","isRequired":true,"isMultiSelect":true,"values":[{}]}],"properties":[{"attributeFQN":"string","values":[{}]}],"isTaxable":true,"inventoryInfo":{"manageStock":true,"outOfStockBehavior":"string"},"shippingClassId":0,"isRecurring":true,"upc":"string","supplierInfo":{"mfgPartNumber":"string","distPartNumber":"string","cost":{"isoCurrencyCode":"string","cost":0}},"isPackagedStandAlone":true,"standAlonePackageType":"string","packageHeight":{"unit":"string","value":0},"packageWidth":{"unit":"string","value":0},"packageLength":{"unit":"string","value":0},"packageWeight":{"unit":"string","value":0},"applicableDiscounts":[{"id":0,"content":{"localeCode":null,"name":null,"friendlyDescription":null,"auditInfo":null},"scope":"string","conditions":{"maxRedemptionCount":null,"requiresCoupon":null,"couponCode":null,"requiresAuthenticatedUser":null,"includedPaymentWorkflows":null,"includedCategories":null,"excludedCategories":null,"includedProducts":null,"excludedProducts":null,"customerSegments":null,"minimumQuantityRequiredProducts":null,"minimumQuantityProductsRequiredInCategories":null,"minimumOrderAmount":null,"maximumOrderAmount":null,"categoriesToExcludeFromMinOrderTotal":null,"productsToExcludeFromMinOrderTotal":null,"minimumLifetimeValueAmount":null,"startDate":null,"expirationDate":null,"minimumCategorySubtotalBeforeDiscounts":null,"minimumRequiredQuantityPerRedemption":null},"target":{"type":null,"includeAllProducts":null,"includedCategoriesOperator":null,"categories":null,"excludedCategoriesOperator":null,"excludedCategories":null,"products":null,"excludedProducts":null,"excludeItemsWithExistingShippingDiscounts":null,"excludeItemsWithExistingProductDiscounts":null,"shippingMethods":null,"shippingZones":null,"maximumQuantityPerRedemption":null,"appliesToLeastExpensiveProductsFirst":null},"currentRedemptionCount":0,"amount":0,"amountType":"string","status":"string","canBeDeleted":true,"doesNotApplyToSalePrice":true,"doesNotApplyToProductsWithSalePrice":true,"maximumUsesPerUser":0,"maximumDiscountImpactPerOrder":0,"maximumDiscountImpactPerRedemption":0,"maximumRedemptionsPerOrder":0,"includedPriceLists":["string"],"doesNotApplyToMultiShipToOrders":true,"isBxGx":true,"canBeStackedUpon":true,"stackingLayer":0,"thresholdMessage":{"discountId":null,"thresholdValue":null,"isActive":null,"showInCart":null,"showOnCheckout":null,"requiresCouponCode":null,"content":null,"auditInfo":null},"preventLineItemShippingDiscounts":true,"preventOrderProductDiscounts":true,"preventOrderShippingDiscounts":true,"hasPurchaseConditions":true,"purchaseRequirementType":"string","auditInfo":{"updateDate":null,"createDate":null,"updateBy":null,"createBy":null}}],"isVariation":true,"variationKey":"string","hasConfigurableOptions":true,"hasStandAloneOptions":true,"variationOptions":[{"attributeFQN":"string","value":{},"content":{"localeCode":null,"stringValue":null}}],"publishingInfo":{"publishedState":"string","lastPublishedBy":"string","lastPublishedDate":"2019-08-24T14:15:22Z","publishSetCode":"string"},"bundledProducts":[{"productCode":"string","quantity":0,"price":{"isoCurrencyCode":null,"price":null,"salePrice":null,"msrp":null,"map":null,"mapStartDate":null,"mapEndDate":null,"creditValue":null},"productName":"string","packageHeight":{"unit":null,"value":null},"packageWidth":{"unit":null,"value":null},"packageLength":{"unit":null,"value":null},"packageWeight":{"unit":null,"value":null},"fulfillmentTypesSupported":["string"]}],"productImageGroups":[{"productImageGroupId":"string","productImageGroupTags":[{}]}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"},"slicingSettings":{"slicingAttributeFqn":"string"}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductCollection |
post__commerce_catalog_admin_products
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/products \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/products HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"productCode": "string",
"productUsage": "string",
"fulfillmentTypesSupported": [
"string"
],
"masterCatalogId": 0,
"productSequence": 0,
"productTypeId": 0,
"isValidForProductType": true,
"baseProductCode": "string",
"productInCatalogs": [
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": null,
"localeCode": null,
"imageLabel": null,
"altText": null,
"imageUrl": null,
"cmsId": null,
"videoUrl": null,
"mediaType": null,
"sequence": null,
"productImageGroupId": null
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"variationPricingMethod": "string"
},
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"extras": [
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": null,
"deltaPrice": null
},
"localizedDeltaPrice": [
{}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"properties": [
{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"isTaxable": true,
"inventoryInfo": {
"manageStock": true,
"outOfStockBehavior": "string"
},
"shippingClassId": 0,
"isRecurring": true,
"upc": "string",
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
},
"isPackagedStandAlone": true,
"standAlonePackageType": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"applicableDiscounts": [
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": null
}
],
"excludedCategories": [
{
"categoryId": null
}
],
"includedProducts": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"customerSegments": [
{
"id": null
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": null
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": null
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": null
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": null
}
],
"products": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": null,
"name": null
}
],
"shippingZones": [
{
"zone": null
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"isVariation": true,
"variationKey": "string",
"hasConfigurableOptions": true,
"hasStandAloneOptions": true,
"variationOptions": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
}
}
],
"publishingInfo": {
"publishedState": "string",
"lastPublishedBy": "string",
"lastPublishedDate": "2019-08-24T14:15:22Z",
"publishSetCode": "string"
},
"bundledProducts": [
{
"productCode": "string",
"quantity": 0,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"productName": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"fulfillmentTypesSupported": [
"string"
]
}
],
"productImageGroups": [
{
"productImageGroupId": "string",
"productImageGroupTags": [
{
"fqn": "string",
"values": [
"string"
]
}
]
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"slicingSettings": {
"slicingAttributeFqn": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/products',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/products', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/products', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/products", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/products
Creates a new product. You supply a product name, product code, price and other product characteristics such as its attributes, categories where the product belongs, whether the product has configurable options, stand-alone options, and so on.
Body parameter
{
"productCode": "string",
"productUsage": "string",
"fulfillmentTypesSupported": [
"string"
],
"masterCatalogId": 0,
"productSequence": 0,
"productTypeId": 0,
"isValidForProductType": true,
"baseProductCode": "string",
"productInCatalogs": [
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": null,
"localeCode": null,
"imageLabel": null,
"altText": null,
"imageUrl": null,
"cmsId": null,
"videoUrl": null,
"mediaType": null,
"sequence": null,
"productImageGroupId": null
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"variationPricingMethod": "string"
},
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"extras": [
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": null,
"deltaPrice": null
},
"localizedDeltaPrice": [
{}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"properties": [
{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"isTaxable": true,
"inventoryInfo": {
"manageStock": true,
"outOfStockBehavior": "string"
},
"shippingClassId": 0,
"isRecurring": true,
"upc": "string",
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
},
"isPackagedStandAlone": true,
"standAlonePackageType": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"applicableDiscounts": [
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": null
}
],
"excludedCategories": [
{
"categoryId": null
}
],
"includedProducts": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"customerSegments": [
{
"id": null
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": null
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": null
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": null
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": null
}
],
"products": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": null,
"name": null
}
],
"shippingZones": [
{
"zone": null
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"isVariation": true,
"variationKey": "string",
"hasConfigurableOptions": true,
"hasStandAloneOptions": true,
"variationOptions": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
}
}
],
"publishingInfo": {
"publishedState": "string",
"lastPublishedBy": "string",
"lastPublishedDate": "2019-08-24T14:15:22Z",
"publishSetCode": "string"
},
"bundledProducts": [
{
"productCode": "string",
"quantity": 0,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"productName": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"fulfillmentTypesSupported": [
"string"
]
}
],
"productImageGroups": [
{
"productImageGroupId": "string",
"productImageGroupTags": [
{
"fqn": "string",
"values": [
"string"
]
}
]
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"slicingSettings": {
"slicingAttributeFqn": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Product | false | Properties of the new product. Required properties: ProductCode, Content.ProductName, and Price.ListPrice. Mozu.ProductAdmin.Contracts.Product |
Example responses
200 Response
{
"productCode": "string",
"productUsage": "string",
"fulfillmentTypesSupported": [
"string"
],
"masterCatalogId": 0,
"productSequence": 0,
"productTypeId": 0,
"isValidForProductType": true,
"baseProductCode": "string",
"productInCatalogs": [
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": null,
"localeCode": null,
"imageLabel": null,
"altText": null,
"imageUrl": null,
"cmsId": null,
"videoUrl": null,
"mediaType": null,
"sequence": null,
"productImageGroupId": null
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"variationPricingMethod": "string"
},
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"extras": [
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": null,
"deltaPrice": null
},
"localizedDeltaPrice": [
{}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"properties": [
{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"isTaxable": true,
"inventoryInfo": {
"manageStock": true,
"outOfStockBehavior": "string"
},
"shippingClassId": 0,
"isRecurring": true,
"upc": "string",
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
},
"isPackagedStandAlone": true,
"standAlonePackageType": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"applicableDiscounts": [
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": null
}
],
"excludedCategories": [
{
"categoryId": null
}
],
"includedProducts": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"customerSegments": [
{
"id": null
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": null
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": null
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": null
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": null
}
],
"products": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": null,
"name": null
}
],
"shippingZones": [
{
"zone": null
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"isVariation": true,
"variationKey": "string",
"hasConfigurableOptions": true,
"hasStandAloneOptions": true,
"variationOptions": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
}
}
],
"publishingInfo": {
"publishedState": "string",
"lastPublishedBy": "string",
"lastPublishedDate": "2019-08-24T14:15:22Z",
"publishSetCode": "string"
},
"bundledProducts": [
{
"productCode": "string",
"quantity": 0,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"productName": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"fulfillmentTypesSupported": [
"string"
]
}
],
"productImageGroups": [
{
"productImageGroupId": "string",
"productImageGroupTags": [
{
"fqn": "string",
"values": [
"string"
]
}
]
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"slicingSettings": {
"slicingAttributeFqn": "string"
}
}
{"productCode":"string","productUsage":"string","fulfillmentTypesSupported":["string"],"masterCatalogId":0,"productSequence":0,"productTypeId":0,"isValidForProductType":true,"baseProductCode":"string","productInCatalogs":[{"catalogId":0,"isActive":true,"isContentOverridden":true,"content":{"localeCode":"string","productName":"string","productFullDescription":"string","productShortDescription":"string","productImages":[{"id":null,"localeCode":null,"imageLabel":null,"altText":null,"imageUrl":null,"cmsId":null,"videoUrl":null,"mediaType":null,"sequence":null,"productImageGroupId":null}]},"isPriceOverridden":true,"price":{"isoCurrencyCode":"string","price":0,"salePrice":0,"msrp":0,"map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","creditValue":0},"isSeoContentOverridden":true,"seoContent":{"localeCode":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","titleTagTitle":"string","seoFriendlyUrl":"string"},"productCategories":[{"categoryId":0}],"primaryProductCategory":{"categoryId":0},"dateFirstAvailableInCatalog":"2019-08-24T14:15:22Z","activeDateRange":{"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}],"content":{"localeCode":"string","productName":"string","productFullDescription":"string","productShortDescription":"string","productImages":[{"id":0,"localeCode":"string","imageLabel":"string","altText":"string","imageUrl":"string","cmsId":"string","videoUrl":"string","mediaType":"string","sequence":0,"productImageGroupId":"string"}]},"price":{"isoCurrencyCode":"string","price":0,"salePrice":0,"msrp":0,"map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","creditValue":0},"pricingBehavior":{"discountsRestricted":true,"discountsRestrictedStartDate":"2019-08-24T14:15:22Z","discountsRestrictedEndDate":"2019-08-24T14:15:22Z","variationPricingMethod":"string"},"seoContent":{"localeCode":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","titleTagTitle":"string","seoFriendlyUrl":"string"},"options":[{"attributeFQN":"string","isProductImageGroupSelector":true,"values":[{"value":{},"attributeVocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}]}],"extras":[{"attributeFQN":"string","isRequired":true,"isMultiSelect":true,"values":[{"value":{},"deltaPrice":{"currencyCode":null,"deltaPrice":null},"localizedDeltaPrice":[{}],"deltaWeight":0,"isDefaulted":true,"quantity":0,"attributeVocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}]}],"properties":[{"attributeFQN":"string","values":[{"value":{},"content":{"localeCode":null,"stringValue":null},"localizedContent":[{}],"attributeVocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}]}],"isTaxable":true,"inventoryInfo":{"manageStock":true,"outOfStockBehavior":"string"},"shippingClassId":0,"isRecurring":true,"upc":"string","supplierInfo":{"mfgPartNumber":"string","distPartNumber":"string","cost":{"isoCurrencyCode":"string","cost":0}},"isPackagedStandAlone":true,"standAlonePackageType":"string","packageHeight":{"unit":"string","value":0},"packageWidth":{"unit":"string","value":0},"packageLength":{"unit":"string","value":0},"packageWeight":{"unit":"string","value":0},"applicableDiscounts":[{"id":0,"content":{"localeCode":"string","name":"string","friendlyDescription":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"scope":"string","conditions":{"maxRedemptionCount":0,"requiresCoupon":true,"couponCode":"string","requiresAuthenticatedUser":true,"includedPaymentWorkflows":["string"],"includedCategories":[{"categoryId":null}],"excludedCategories":[{"categoryId":null}],"includedProducts":[{"productCode":null}],"excludedProducts":[{"productCode":null}],"customerSegments":[{"id":null}],"minimumQuantityRequiredProducts":0,"minimumQuantityProductsRequiredInCategories":0,"minimumOrderAmount":0,"maximumOrderAmount":0,"categoriesToExcludeFromMinOrderTotal":[{"categoryId":null}],"productsToExcludeFromMinOrderTotal":[{"productCode":null}],"minimumLifetimeValueAmount":0,"startDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","minimumCategorySubtotalBeforeDiscounts":0,"minimumRequiredQuantityPerRedemption":0},"target":{"type":"string","includeAllProducts":true,"includedCategoriesOperator":"string","categories":[{"id":null}],"excludedCategoriesOperator":"string","excludedCategories":[{"id":null}],"products":[{"productCode":null}],"excludedProducts":[{"productCode":null}],"excludeItemsWithExistingShippingDiscounts":true,"excludeItemsWithExistingProductDiscounts":true,"shippingMethods":[{"code":null,"name":null}],"shippingZones":[{"zone":null}],"maximumQuantityPerRedemption":0,"appliesToLeastExpensiveProductsFirst":true},"currentRedemptionCount":0,"amount":0,"amountType":"string","status":"string","canBeDeleted":true,"doesNotApplyToSalePrice":true,"doesNotApplyToProductsWithSalePrice":true,"maximumUsesPerUser":0,"maximumDiscountImpactPerOrder":0,"maximumDiscountImpactPerRedemption":0,"maximumRedemptionsPerOrder":0,"includedPriceLists":["string"],"doesNotApplyToMultiShipToOrders":true,"isBxGx":true,"canBeStackedUpon":true,"stackingLayer":0,"thresholdMessage":{"discountId":0,"thresholdValue":0,"isActive":true,"showInCart":true,"showOnCheckout":true,"requiresCouponCode":true,"content":{"localeCode":"string","messageTemplate":"string","auditInfo":{}},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"preventLineItemShippingDiscounts":true,"preventOrderProductDiscounts":true,"preventOrderShippingDiscounts":true,"hasPurchaseConditions":true,"purchaseRequirementType":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}],"isVariation":true,"variationKey":"string","hasConfigurableOptions":true,"hasStandAloneOptions":true,"variationOptions":[{"attributeFQN":"string","value":{},"content":{"localeCode":"string","stringValue":"string"}}],"publishingInfo":{"publishedState":"string","lastPublishedBy":"string","lastPublishedDate":"2019-08-24T14:15:22Z","publishSetCode":"string"},"bundledProducts":[{"productCode":"string","quantity":0,"price":{"isoCurrencyCode":"string","price":0,"salePrice":0,"msrp":0,"map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","creditValue":0},"productName":"string","packageHeight":{"unit":"string","value":0},"packageWidth":{"unit":"string","value":0},"packageLength":{"unit":"string","value":0},"packageWeight":{"unit":"string","value":0},"fulfillmentTypesSupported":["string"]}],"productImageGroups":[{"productImageGroupId":"string","productImageGroupTags":[{"fqn":"string","values":["string"]}]}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"},"slicingSettings":{"slicingAttributeFqn":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Product |
get_commerce_catalog_admin_products{productCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}
Retrieves details about a product based on the specified response group. For example, to get the BaseProductCode of a product.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | Merchant-created code associated with the product, for example, a SKU. Required. |
| responseGroups | query | string | false | Used to get more specific information from the request. For example to get discounts applied to a product use the AppliedProducts response group. Available response groups: ApplicableDiscounts, VariationOptions, and BaseProductCode. |
Example responses
200 Response
{
"productCode": "string",
"productUsage": "string",
"fulfillmentTypesSupported": [
"string"
],
"masterCatalogId": 0,
"productSequence": 0,
"productTypeId": 0,
"isValidForProductType": true,
"baseProductCode": "string",
"productInCatalogs": [
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": null,
"localeCode": null,
"imageLabel": null,
"altText": null,
"imageUrl": null,
"cmsId": null,
"videoUrl": null,
"mediaType": null,
"sequence": null,
"productImageGroupId": null
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"variationPricingMethod": "string"
},
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"extras": [
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": null,
"deltaPrice": null
},
"localizedDeltaPrice": [
{}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"properties": [
{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"isTaxable": true,
"inventoryInfo": {
"manageStock": true,
"outOfStockBehavior": "string"
},
"shippingClassId": 0,
"isRecurring": true,
"upc": "string",
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
},
"isPackagedStandAlone": true,
"standAlonePackageType": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"applicableDiscounts": [
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": null
}
],
"excludedCategories": [
{
"categoryId": null
}
],
"includedProducts": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"customerSegments": [
{
"id": null
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": null
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": null
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": null
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": null
}
],
"products": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": null,
"name": null
}
],
"shippingZones": [
{
"zone": null
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"isVariation": true,
"variationKey": "string",
"hasConfigurableOptions": true,
"hasStandAloneOptions": true,
"variationOptions": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
}
}
],
"publishingInfo": {
"publishedState": "string",
"lastPublishedBy": "string",
"lastPublishedDate": "2019-08-24T14:15:22Z",
"publishSetCode": "string"
},
"bundledProducts": [
{
"productCode": "string",
"quantity": 0,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"productName": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"fulfillmentTypesSupported": [
"string"
]
}
],
"productImageGroups": [
{
"productImageGroupId": "string",
"productImageGroupTags": [
{
"fqn": "string",
"values": [
"string"
]
}
]
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"slicingSettings": {
"slicingAttributeFqn": "string"
}
}
{"productCode":"string","productUsage":"string","fulfillmentTypesSupported":["string"],"masterCatalogId":0,"productSequence":0,"productTypeId":0,"isValidForProductType":true,"baseProductCode":"string","productInCatalogs":[{"catalogId":0,"isActive":true,"isContentOverridden":true,"content":{"localeCode":"string","productName":"string","productFullDescription":"string","productShortDescription":"string","productImages":[{"id":null,"localeCode":null,"imageLabel":null,"altText":null,"imageUrl":null,"cmsId":null,"videoUrl":null,"mediaType":null,"sequence":null,"productImageGroupId":null}]},"isPriceOverridden":true,"price":{"isoCurrencyCode":"string","price":0,"salePrice":0,"msrp":0,"map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","creditValue":0},"isSeoContentOverridden":true,"seoContent":{"localeCode":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","titleTagTitle":"string","seoFriendlyUrl":"string"},"productCategories":[{"categoryId":0}],"primaryProductCategory":{"categoryId":0},"dateFirstAvailableInCatalog":"2019-08-24T14:15:22Z","activeDateRange":{"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}],"content":{"localeCode":"string","productName":"string","productFullDescription":"string","productShortDescription":"string","productImages":[{"id":0,"localeCode":"string","imageLabel":"string","altText":"string","imageUrl":"string","cmsId":"string","videoUrl":"string","mediaType":"string","sequence":0,"productImageGroupId":"string"}]},"price":{"isoCurrencyCode":"string","price":0,"salePrice":0,"msrp":0,"map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","creditValue":0},"pricingBehavior":{"discountsRestricted":true,"discountsRestrictedStartDate":"2019-08-24T14:15:22Z","discountsRestrictedEndDate":"2019-08-24T14:15:22Z","variationPricingMethod":"string"},"seoContent":{"localeCode":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","titleTagTitle":"string","seoFriendlyUrl":"string"},"options":[{"attributeFQN":"string","isProductImageGroupSelector":true,"values":[{"value":{},"attributeVocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}]}],"extras":[{"attributeFQN":"string","isRequired":true,"isMultiSelect":true,"values":[{"value":{},"deltaPrice":{"currencyCode":null,"deltaPrice":null},"localizedDeltaPrice":[{}],"deltaWeight":0,"isDefaulted":true,"quantity":0,"attributeVocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}]}],"properties":[{"attributeFQN":"string","values":[{"value":{},"content":{"localeCode":null,"stringValue":null},"localizedContent":[{}],"attributeVocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}]}],"isTaxable":true,"inventoryInfo":{"manageStock":true,"outOfStockBehavior":"string"},"shippingClassId":0,"isRecurring":true,"upc":"string","supplierInfo":{"mfgPartNumber":"string","distPartNumber":"string","cost":{"isoCurrencyCode":"string","cost":0}},"isPackagedStandAlone":true,"standAlonePackageType":"string","packageHeight":{"unit":"string","value":0},"packageWidth":{"unit":"string","value":0},"packageLength":{"unit":"string","value":0},"packageWeight":{"unit":"string","value":0},"applicableDiscounts":[{"id":0,"content":{"localeCode":"string","name":"string","friendlyDescription":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"scope":"string","conditions":{"maxRedemptionCount":0,"requiresCoupon":true,"couponCode":"string","requiresAuthenticatedUser":true,"includedPaymentWorkflows":["string"],"includedCategories":[{"categoryId":null}],"excludedCategories":[{"categoryId":null}],"includedProducts":[{"productCode":null}],"excludedProducts":[{"productCode":null}],"customerSegments":[{"id":null}],"minimumQuantityRequiredProducts":0,"minimumQuantityProductsRequiredInCategories":0,"minimumOrderAmount":0,"maximumOrderAmount":0,"categoriesToExcludeFromMinOrderTotal":[{"categoryId":null}],"productsToExcludeFromMinOrderTotal":[{"productCode":null}],"minimumLifetimeValueAmount":0,"startDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","minimumCategorySubtotalBeforeDiscounts":0,"minimumRequiredQuantityPerRedemption":0},"target":{"type":"string","includeAllProducts":true,"includedCategoriesOperator":"string","categories":[{"id":null}],"excludedCategoriesOperator":"string","excludedCategories":[{"id":null}],"products":[{"productCode":null}],"excludedProducts":[{"productCode":null}],"excludeItemsWithExistingShippingDiscounts":true,"excludeItemsWithExistingProductDiscounts":true,"shippingMethods":[{"code":null,"name":null}],"shippingZones":[{"zone":null}],"maximumQuantityPerRedemption":0,"appliesToLeastExpensiveProductsFirst":true},"currentRedemptionCount":0,"amount":0,"amountType":"string","status":"string","canBeDeleted":true,"doesNotApplyToSalePrice":true,"doesNotApplyToProductsWithSalePrice":true,"maximumUsesPerUser":0,"maximumDiscountImpactPerOrder":0,"maximumDiscountImpactPerRedemption":0,"maximumRedemptionsPerOrder":0,"includedPriceLists":["string"],"doesNotApplyToMultiShipToOrders":true,"isBxGx":true,"canBeStackedUpon":true,"stackingLayer":0,"thresholdMessage":{"discountId":0,"thresholdValue":0,"isActive":true,"showInCart":true,"showOnCheckout":true,"requiresCouponCode":true,"content":{"localeCode":"string","messageTemplate":"string","auditInfo":{}},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"preventLineItemShippingDiscounts":true,"preventOrderProductDiscounts":true,"preventOrderShippingDiscounts":true,"hasPurchaseConditions":true,"purchaseRequirementType":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}],"isVariation":true,"variationKey":"string","hasConfigurableOptions":true,"hasStandAloneOptions":true,"variationOptions":[{"attributeFQN":"string","value":{},"content":{"localeCode":"string","stringValue":"string"}}],"publishingInfo":{"publishedState":"string","lastPublishedBy":"string","lastPublishedDate":"2019-08-24T14:15:22Z","publishSetCode":"string"},"bundledProducts":[{"productCode":"string","quantity":0,"price":{"isoCurrencyCode":"string","price":0,"salePrice":0,"msrp":0,"map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","creditValue":0},"productName":"string","packageHeight":{"unit":"string","value":0},"packageWidth":{"unit":"string","value":0},"packageLength":{"unit":"string","value":0},"packageWeight":{"unit":"string","value":0},"fulfillmentTypesSupported":["string"]}],"productImageGroups":[{"productImageGroupId":"string","productImageGroupTags":[{"fqn":"string","values":["string"]}]}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"},"slicingSettings":{"slicingAttributeFqn":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Product |
put_commerce_catalog_admin_products{productCode}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"productCode": "string",
"productUsage": "string",
"fulfillmentTypesSupported": [
"string"
],
"masterCatalogId": 0,
"productSequence": 0,
"productTypeId": 0,
"isValidForProductType": true,
"baseProductCode": "string",
"productInCatalogs": [
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": null,
"localeCode": null,
"imageLabel": null,
"altText": null,
"imageUrl": null,
"cmsId": null,
"videoUrl": null,
"mediaType": null,
"sequence": null,
"productImageGroupId": null
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"variationPricingMethod": "string"
},
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"extras": [
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": null,
"deltaPrice": null
},
"localizedDeltaPrice": [
{}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"properties": [
{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"isTaxable": true,
"inventoryInfo": {
"manageStock": true,
"outOfStockBehavior": "string"
},
"shippingClassId": 0,
"isRecurring": true,
"upc": "string",
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
},
"isPackagedStandAlone": true,
"standAlonePackageType": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"applicableDiscounts": [
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": null
}
],
"excludedCategories": [
{
"categoryId": null
}
],
"includedProducts": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"customerSegments": [
{
"id": null
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": null
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": null
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": null
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": null
}
],
"products": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": null,
"name": null
}
],
"shippingZones": [
{
"zone": null
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"isVariation": true,
"variationKey": "string",
"hasConfigurableOptions": true,
"hasStandAloneOptions": true,
"variationOptions": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
}
}
],
"publishingInfo": {
"publishedState": "string",
"lastPublishedBy": "string",
"lastPublishedDate": "2019-08-24T14:15:22Z",
"publishSetCode": "string"
},
"bundledProducts": [
{
"productCode": "string",
"quantity": 0,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"productName": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"fulfillmentTypesSupported": [
"string"
]
}
],
"productImageGroups": [
{
"productImageGroupId": "string",
"productImageGroupTags": [
{
"fqn": "string",
"values": [
"string"
]
}
]
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"slicingSettings": {
"slicingAttributeFqn": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}
Modifies an existing product.
Body parameter
{
"productCode": "string",
"productUsage": "string",
"fulfillmentTypesSupported": [
"string"
],
"masterCatalogId": 0,
"productSequence": 0,
"productTypeId": 0,
"isValidForProductType": true,
"baseProductCode": "string",
"productInCatalogs": [
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": null,
"localeCode": null,
"imageLabel": null,
"altText": null,
"imageUrl": null,
"cmsId": null,
"videoUrl": null,
"mediaType": null,
"sequence": null,
"productImageGroupId": null
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"variationPricingMethod": "string"
},
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"extras": [
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": null,
"deltaPrice": null
},
"localizedDeltaPrice": [
{}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"properties": [
{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"isTaxable": true,
"inventoryInfo": {
"manageStock": true,
"outOfStockBehavior": "string"
},
"shippingClassId": 0,
"isRecurring": true,
"upc": "string",
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
},
"isPackagedStandAlone": true,
"standAlonePackageType": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"applicableDiscounts": [
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": null
}
],
"excludedCategories": [
{
"categoryId": null
}
],
"includedProducts": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"customerSegments": [
{
"id": null
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": null
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": null
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": null
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": null
}
],
"products": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": null,
"name": null
}
],
"shippingZones": [
{
"zone": null
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"isVariation": true,
"variationKey": "string",
"hasConfigurableOptions": true,
"hasStandAloneOptions": true,
"variationOptions": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
}
}
],
"publishingInfo": {
"publishedState": "string",
"lastPublishedBy": "string",
"lastPublishedDate": "2019-08-24T14:15:22Z",
"publishSetCode": "string"
},
"bundledProducts": [
{
"productCode": "string",
"quantity": 0,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"productName": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"fulfillmentTypesSupported": [
"string"
]
}
],
"productImageGroups": [
{
"productImageGroupId": "string",
"productImageGroupTags": [
{
"fqn": "string",
"values": [
"string"
]
}
]
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"slicingSettings": {
"slicingAttributeFqn": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | Merchant-created code associated with the product, for example, a SKU. Required. |
| body | body | Product | false | Properties of the product that you want to update. Required properties: ProductCode, Content.ProductName, and Price.ListPrice. |
Example responses
200 Response
{
"productCode": "string",
"productUsage": "string",
"fulfillmentTypesSupported": [
"string"
],
"masterCatalogId": 0,
"productSequence": 0,
"productTypeId": 0,
"isValidForProductType": true,
"baseProductCode": "string",
"productInCatalogs": [
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": null,
"localeCode": null,
"imageLabel": null,
"altText": null,
"imageUrl": null,
"cmsId": null,
"videoUrl": null,
"mediaType": null,
"sequence": null,
"productImageGroupId": null
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"variationPricingMethod": "string"
},
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"extras": [
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": null,
"deltaPrice": null
},
"localizedDeltaPrice": [
{}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"properties": [
{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"isTaxable": true,
"inventoryInfo": {
"manageStock": true,
"outOfStockBehavior": "string"
},
"shippingClassId": 0,
"isRecurring": true,
"upc": "string",
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
},
"isPackagedStandAlone": true,
"standAlonePackageType": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"applicableDiscounts": [
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": null
}
],
"excludedCategories": [
{
"categoryId": null
}
],
"includedProducts": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"customerSegments": [
{
"id": null
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": null
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": null
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": null
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": null
}
],
"products": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": null,
"name": null
}
],
"shippingZones": [
{
"zone": null
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"isVariation": true,
"variationKey": "string",
"hasConfigurableOptions": true,
"hasStandAloneOptions": true,
"variationOptions": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
}
}
],
"publishingInfo": {
"publishedState": "string",
"lastPublishedBy": "string",
"lastPublishedDate": "2019-08-24T14:15:22Z",
"publishSetCode": "string"
},
"bundledProducts": [
{
"productCode": "string",
"quantity": 0,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"productName": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"fulfillmentTypesSupported": [
"string"
]
}
],
"productImageGroups": [
{
"productImageGroupId": "string",
"productImageGroupTags": [
{
"fqn": "string",
"values": [
"string"
]
}
]
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"slicingSettings": {
"slicingAttributeFqn": "string"
}
}
{"productCode":"string","productUsage":"string","fulfillmentTypesSupported":["string"],"masterCatalogId":0,"productSequence":0,"productTypeId":0,"isValidForProductType":true,"baseProductCode":"string","productInCatalogs":[{"catalogId":0,"isActive":true,"isContentOverridden":true,"content":{"localeCode":"string","productName":"string","productFullDescription":"string","productShortDescription":"string","productImages":[{"id":null,"localeCode":null,"imageLabel":null,"altText":null,"imageUrl":null,"cmsId":null,"videoUrl":null,"mediaType":null,"sequence":null,"productImageGroupId":null}]},"isPriceOverridden":true,"price":{"isoCurrencyCode":"string","price":0,"salePrice":0,"msrp":0,"map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","creditValue":0},"isSeoContentOverridden":true,"seoContent":{"localeCode":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","titleTagTitle":"string","seoFriendlyUrl":"string"},"productCategories":[{"categoryId":0}],"primaryProductCategory":{"categoryId":0},"dateFirstAvailableInCatalog":"2019-08-24T14:15:22Z","activeDateRange":{"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}],"content":{"localeCode":"string","productName":"string","productFullDescription":"string","productShortDescription":"string","productImages":[{"id":0,"localeCode":"string","imageLabel":"string","altText":"string","imageUrl":"string","cmsId":"string","videoUrl":"string","mediaType":"string","sequence":0,"productImageGroupId":"string"}]},"price":{"isoCurrencyCode":"string","price":0,"salePrice":0,"msrp":0,"map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","creditValue":0},"pricingBehavior":{"discountsRestricted":true,"discountsRestrictedStartDate":"2019-08-24T14:15:22Z","discountsRestrictedEndDate":"2019-08-24T14:15:22Z","variationPricingMethod":"string"},"seoContent":{"localeCode":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","titleTagTitle":"string","seoFriendlyUrl":"string"},"options":[{"attributeFQN":"string","isProductImageGroupSelector":true,"values":[{"value":{},"attributeVocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}]}],"extras":[{"attributeFQN":"string","isRequired":true,"isMultiSelect":true,"values":[{"value":{},"deltaPrice":{"currencyCode":null,"deltaPrice":null},"localizedDeltaPrice":[{}],"deltaWeight":0,"isDefaulted":true,"quantity":0,"attributeVocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}]}],"properties":[{"attributeFQN":"string","values":[{"value":{},"content":{"localeCode":null,"stringValue":null},"localizedContent":[{}],"attributeVocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}]}],"isTaxable":true,"inventoryInfo":{"manageStock":true,"outOfStockBehavior":"string"},"shippingClassId":0,"isRecurring":true,"upc":"string","supplierInfo":{"mfgPartNumber":"string","distPartNumber":"string","cost":{"isoCurrencyCode":"string","cost":0}},"isPackagedStandAlone":true,"standAlonePackageType":"string","packageHeight":{"unit":"string","value":0},"packageWidth":{"unit":"string","value":0},"packageLength":{"unit":"string","value":0},"packageWeight":{"unit":"string","value":0},"applicableDiscounts":[{"id":0,"content":{"localeCode":"string","name":"string","friendlyDescription":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"scope":"string","conditions":{"maxRedemptionCount":0,"requiresCoupon":true,"couponCode":"string","requiresAuthenticatedUser":true,"includedPaymentWorkflows":["string"],"includedCategories":[{"categoryId":null}],"excludedCategories":[{"categoryId":null}],"includedProducts":[{"productCode":null}],"excludedProducts":[{"productCode":null}],"customerSegments":[{"id":null}],"minimumQuantityRequiredProducts":0,"minimumQuantityProductsRequiredInCategories":0,"minimumOrderAmount":0,"maximumOrderAmount":0,"categoriesToExcludeFromMinOrderTotal":[{"categoryId":null}],"productsToExcludeFromMinOrderTotal":[{"productCode":null}],"minimumLifetimeValueAmount":0,"startDate":"2019-08-24T14:15:22Z","expirationDate":"2019-08-24T14:15:22Z","minimumCategorySubtotalBeforeDiscounts":0,"minimumRequiredQuantityPerRedemption":0},"target":{"type":"string","includeAllProducts":true,"includedCategoriesOperator":"string","categories":[{"id":null}],"excludedCategoriesOperator":"string","excludedCategories":[{"id":null}],"products":[{"productCode":null}],"excludedProducts":[{"productCode":null}],"excludeItemsWithExistingShippingDiscounts":true,"excludeItemsWithExistingProductDiscounts":true,"shippingMethods":[{"code":null,"name":null}],"shippingZones":[{"zone":null}],"maximumQuantityPerRedemption":0,"appliesToLeastExpensiveProductsFirst":true},"currentRedemptionCount":0,"amount":0,"amountType":"string","status":"string","canBeDeleted":true,"doesNotApplyToSalePrice":true,"doesNotApplyToProductsWithSalePrice":true,"maximumUsesPerUser":0,"maximumDiscountImpactPerOrder":0,"maximumDiscountImpactPerRedemption":0,"maximumRedemptionsPerOrder":0,"includedPriceLists":["string"],"doesNotApplyToMultiShipToOrders":true,"isBxGx":true,"canBeStackedUpon":true,"stackingLayer":0,"thresholdMessage":{"discountId":0,"thresholdValue":0,"isActive":true,"showInCart":true,"showOnCheckout":true,"requiresCouponCode":true,"content":{"localeCode":"string","messageTemplate":"string","auditInfo":{}},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}},"preventLineItemShippingDiscounts":true,"preventOrderProductDiscounts":true,"preventOrderShippingDiscounts":true,"hasPurchaseConditions":true,"purchaseRequirementType":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}],"isVariation":true,"variationKey":"string","hasConfigurableOptions":true,"hasStandAloneOptions":true,"variationOptions":[{"attributeFQN":"string","value":{},"content":{"localeCode":"string","stringValue":"string"}}],"publishingInfo":{"publishedState":"string","lastPublishedBy":"string","lastPublishedDate":"2019-08-24T14:15:22Z","publishSetCode":"string"},"bundledProducts":[{"productCode":"string","quantity":0,"price":{"isoCurrencyCode":"string","price":0,"salePrice":0,"msrp":0,"map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","creditValue":0},"productName":"string","packageHeight":{"unit":"string","value":0},"packageWidth":{"unit":"string","value":0},"packageLength":{"unit":"string","value":0},"packageWeight":{"unit":"string","value":0},"fulfillmentTypesSupported":["string"]}],"productImageGroups":[{"productImageGroupId":"string","productImageGroupTags":[{"fqn":"string","values":["string"]}]}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"},"slicingSettings":{"slicingAttributeFqn":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Product |
delete_commerce_catalog_admin_products{productCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/products/{productCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/products/{productCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/products/{productCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/products/{productCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/products/{productCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/products/{productCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/products/{productCode}
Deletes the product specified by its product code.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | Merchant-created code associated with the product, for example, a SKU. Required. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
put_commerce_catalog_admin_products{productCode}ProductInCatalogs{catalogId}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}
Body parameter
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| catalogId | path | integer(int32) | true | none |
| body | body | ProductInCatalogInfo | false | none |
Example responses
200 Response
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"catalogId":0,"isActive":true,"isContentOverridden":true,"content":{"localeCode":"string","productName":"string","productFullDescription":"string","productShortDescription":"string","productImages":[{"id":0,"localeCode":"string","imageLabel":"string","altText":"string","imageUrl":"string","cmsId":"string","videoUrl":"string","mediaType":"string","sequence":0,"productImageGroupId":"string"}]},"isPriceOverridden":true,"price":{"isoCurrencyCode":"string","price":0,"salePrice":0,"msrp":0,"map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","creditValue":0},"isSeoContentOverridden":true,"seoContent":{"localeCode":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","titleTagTitle":"string","seoFriendlyUrl":"string"},"productCategories":[{"categoryId":0}],"primaryProductCategory":{"categoryId":0},"dateFirstAvailableInCatalog":"2019-08-24T14:15:22Z","activeDateRange":{"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductInCatalogInfo |
delete_commerce_catalog_admin_products{productCode}ProductInCatalogs{catalogId}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| catalogId | path | integer(int32) | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_products{productCode}ProductInCatalogs{catalogId}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/ProductInCatalogs/{catalogId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| catalogId | path | integer(int32) | true | none |
Example responses
200 Response
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"catalogId":0,"isActive":true,"isContentOverridden":true,"content":{"localeCode":"string","productName":"string","productFullDescription":"string","productShortDescription":"string","productImages":[{"id":0,"localeCode":"string","imageLabel":"string","altText":"string","imageUrl":"string","cmsId":"string","videoUrl":"string","mediaType":"string","sequence":0,"productImageGroupId":"string"}]},"isPriceOverridden":true,"price":{"isoCurrencyCode":"string","price":0,"salePrice":0,"msrp":0,"map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","creditValue":0},"isSeoContentOverridden":true,"seoContent":{"localeCode":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","titleTagTitle":"string","seoFriendlyUrl":"string"},"productCategories":[{"categoryId":0}],"primaryProductCategory":{"categoryId":0},"dateFirstAvailableInCatalog":"2019-08-24T14:15:22Z","activeDateRange":{"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductInCatalogInfo |
get_commerce_catalog_admin_products{productCode}_ProductInCatalogs
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/ProductInCatalogs \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/ProductInCatalogs HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/ProductInCatalogs',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/ProductInCatalogs',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/ProductInCatalogs', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/ProductInCatalogs', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/ProductInCatalogs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/ProductInCatalogs", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/ProductInCatalogs
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
Example responses
200 Response
[
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
[{"catalogId":0,"isActive":true,"isContentOverridden":true,"content":{"localeCode":"string","productName":"string","productFullDescription":"string","productShortDescription":"string","productImages":[{"id":0,"localeCode":"string","imageLabel":"string","altText":"string","imageUrl":"string","cmsId":"string","videoUrl":"string","mediaType":"string","sequence":0,"productImageGroupId":"string"}]},"isPriceOverridden":true,"price":{"isoCurrencyCode":"string","price":0,"salePrice":0,"msrp":0,"map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","creditValue":0},"isSeoContentOverridden":true,"seoContent":{"localeCode":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","titleTagTitle":"string","seoFriendlyUrl":"string"},"productCategories":[{"categoryId":0}],"primaryProductCategory":{"categoryId":0},"dateFirstAvailableInCatalog":"2019-08-24T14:15:22Z","activeDateRange":{"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ProductInCatalogInfo] | false | none | [Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.] |
| » catalogId | integer(int32) | false | none | The CatalogId of the catalog that the product is associated with (The catalog must a valid catalog within the MasterCatalog that the product belongs to) |
| » isActive | boolean¦null | false | none | If true, the product is marked as available for sale in the catalog. Setting a product to IsActive = false will prevent it from being shown on the customer facing storefront. |
| » isContentOverridden | boolean¦null | false | none | If true, the content for this product is overridden in the catalog. If false, the MasterCatalog level content will be used for the product. |
| » content | ProductLocalizedContent | false | none | Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally. |
| »» localeCode | string¦null | false | none | Lanugage used for product content. Currently, only en_US is supported. |
| »» productName | string¦null | false | none | Name of the product. |
| »» productFullDescription | string¦null | false | none | Long description of the product typically used for a product details page. |
| »» productShortDescription | string¦null | false | none | Brief description of the product typically used when the product is displayed in a list or search results. |
| »» productImages | [ProductLocalizedImage]¦null | false | none | List of images associated with the product. |
| »»» id | integer(int32)¦null | false | none | Unique identifier of the image. System-supplied and read-only. |
| »»» localeCode | string¦null | false | none | Language used for the image content. |
| »»» imageLabel | string¦null | false | none | Image title that appears on the storefront. |
| »»» altText | string¦null | false | none | Descriptive text associated with the image or video that appears on the storefront. |
| »»» imageUrl | string¦null | false | none | URL of the image. |
| »»» cmsId | string¦null | false | none | Id of the image in the CMS. |
| »»» videoUrl | string¦null | false | none | URL of a video associated with the product. |
| »»» mediaType | string¦null | false | none | Type of media. Used by the client to determine how to render the image or video or what have you. |
| »»» sequence | integer(int32)¦null | false | none | For products with multiple images, the order in which this image appears on the storefront. |
| »»» productImageGroupId | string¦null | false | none | Image group to which this image belongs. Default is null. |
| » isPriceOverridden | boolean¦null | false | none | If true, the price for this product is overridden in the catalog. If false, the MasterCatalog level price will be used for the product. |
| » price | ProductPrice | false | none | Price of the product and currency used. |
| »» isoCurrencyCode | string¦null | false | none | Currency code. |
| »» price | number(double)¦null | false | none | Price of the product. This is the price the merchant intends to sell the product if no sale price is present. |
| »» salePrice | number(double)¦null | false | none | Current sale price of the product. Sale price is a numeric (monetary) amount, not a percentage off. |
| »» msrp | number(double)¦null | false | none | Manufacturer Suggested Retail Price. + |
| »» map | number(double)¦null | false | none | Minimum Advertised Price |
| »» mapStartDate | string(date-time)¦null | false | none | Minimum Advertised Price effective start date (null = begining of time) |
| »» mapEndDate | string(date-time)¦null | false | none | Minimum Advertised Price effectivity end date (null = forever) |
| »» creditValue | number(double)¦null | false | none | Credit amt of the product |
| » isSeoContentOverridden | boolean¦null | false | none | If true, the SEO content for this product is overridden in the catalog. If false, the MasterCatalog level SEO content will be used for the product. |
| » seoContent | ProductLocalizedSEOContent | false | none | Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally. |
| »» localeCode | string¦null | false | none | Lanugage used for product content. Currently, only en_US is supported. |
| »» metaTagTitle | string¦null | false | none | Metadata title. Metadata can be used to manage information internally. Sometimes used for SEO. |
| »» metaTagDescription | string¦null | false | none | Metadata description. Metadata can be used to manage information internally. Sometimes used for SEO. |
| »» metaTagKeywords | string¦null | false | none | Metadata keywords. Metadata can be used to manage information internally. Sometimes used for SEO. |
| »» titleTagTitle | string¦null | false | none | Used to customize the HTML title tag within the head section of the product details page |
| »» seoFriendlyUrl | string¦null | false | none | Human-readable identifier that you can give to the product to create friendly URLs. For example, instead of "http: //example.com/products?category=2&id=25," the friendly URL can be "http: //example.com/products/category/2/25." |
| » productCategories | [ProductCategory]¦null | false | none | Categories to which the product belongs for this catalog. |
| »» categoryId | integer(int32) | false | none | Unique identifier of the category. System-supplied and read-only. |
| » primaryProductCategory | ProductCategory | false | none | Categories to which the product belongs. |
| » dateFirstAvailableInCatalog | string(date-time)¦null | false | none | Date this product was first Available for sale in the catalog. This is utilized in expressions that reference DaysInCatloag. |
| » activeDateRange | ActiveDateRange | false | none | Active Effectivity Dates |
| »» startDate | string(date-time)¦null | false | none | none |
| »» endDate | string(date-time)¦null | false | none | none |
| » auditInfo | AuditInfo | false | none | none |
| »» updateDate | string(date-time)¦null | false | none | none |
| »» createDate | string(date-time)¦null | false | none | none |
| »» updateBy | string¦null | false | none | none |
| »» createBy | string¦null | false | none | none |
put_commerce_catalog_admin_products{productCode}_ProductInCatalogs
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode}/ProductInCatalogs \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode}/ProductInCatalogs HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/ProductInCatalogs',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}/ProductInCatalogs',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}/ProductInCatalogs', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}/ProductInCatalogs', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/ProductInCatalogs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}/ProductInCatalogs", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}/ProductInCatalogs
Body parameter
[
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| body | body | ProductInCatalogInfo | false | none |
Example responses
200 Response
[
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
[{"catalogId":0,"isActive":true,"isContentOverridden":true,"content":{"localeCode":"string","productName":"string","productFullDescription":"string","productShortDescription":"string","productImages":[{"id":0,"localeCode":"string","imageLabel":"string","altText":"string","imageUrl":"string","cmsId":"string","videoUrl":"string","mediaType":"string","sequence":0,"productImageGroupId":"string"}]},"isPriceOverridden":true,"price":{"isoCurrencyCode":"string","price":0,"salePrice":0,"msrp":0,"map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","creditValue":0},"isSeoContentOverridden":true,"seoContent":{"localeCode":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","titleTagTitle":"string","seoFriendlyUrl":"string"},"productCategories":[{"categoryId":0}],"primaryProductCategory":{"categoryId":0},"dateFirstAvailableInCatalog":"2019-08-24T14:15:22Z","activeDateRange":{"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ProductInCatalogInfo] | false | none | [Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.] |
| » catalogId | integer(int32) | false | none | The CatalogId of the catalog that the product is associated with (The catalog must a valid catalog within the MasterCatalog that the product belongs to) |
| » isActive | boolean¦null | false | none | If true, the product is marked as available for sale in the catalog. Setting a product to IsActive = false will prevent it from being shown on the customer facing storefront. |
| » isContentOverridden | boolean¦null | false | none | If true, the content for this product is overridden in the catalog. If false, the MasterCatalog level content will be used for the product. |
| » content | ProductLocalizedContent | false | none | Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally. |
| »» localeCode | string¦null | false | none | Lanugage used for product content. Currently, only en_US is supported. |
| »» productName | string¦null | false | none | Name of the product. |
| »» productFullDescription | string¦null | false | none | Long description of the product typically used for a product details page. |
| »» productShortDescription | string¦null | false | none | Brief description of the product typically used when the product is displayed in a list or search results. |
| »» productImages | [ProductLocalizedImage]¦null | false | none | List of images associated with the product. |
| »»» id | integer(int32)¦null | false | none | Unique identifier of the image. System-supplied and read-only. |
| »»» localeCode | string¦null | false | none | Language used for the image content. |
| »»» imageLabel | string¦null | false | none | Image title that appears on the storefront. |
| »»» altText | string¦null | false | none | Descriptive text associated with the image or video that appears on the storefront. |
| »»» imageUrl | string¦null | false | none | URL of the image. |
| »»» cmsId | string¦null | false | none | Id of the image in the CMS. |
| »»» videoUrl | string¦null | false | none | URL of a video associated with the product. |
| »»» mediaType | string¦null | false | none | Type of media. Used by the client to determine how to render the image or video or what have you. |
| »»» sequence | integer(int32)¦null | false | none | For products with multiple images, the order in which this image appears on the storefront. |
| »»» productImageGroupId | string¦null | false | none | Image group to which this image belongs. Default is null. |
| » isPriceOverridden | boolean¦null | false | none | If true, the price for this product is overridden in the catalog. If false, the MasterCatalog level price will be used for the product. |
| » price | ProductPrice | false | none | Price of the product and currency used. |
| »» isoCurrencyCode | string¦null | false | none | Currency code. |
| »» price | number(double)¦null | false | none | Price of the product. This is the price the merchant intends to sell the product if no sale price is present. |
| »» salePrice | number(double)¦null | false | none | Current sale price of the product. Sale price is a numeric (monetary) amount, not a percentage off. |
| »» msrp | number(double)¦null | false | none | Manufacturer Suggested Retail Price. + |
| »» map | number(double)¦null | false | none | Minimum Advertised Price |
| »» mapStartDate | string(date-time)¦null | false | none | Minimum Advertised Price effective start date (null = begining of time) |
| »» mapEndDate | string(date-time)¦null | false | none | Minimum Advertised Price effectivity end date (null = forever) |
| »» creditValue | number(double)¦null | false | none | Credit amt of the product |
| » isSeoContentOverridden | boolean¦null | false | none | If true, the SEO content for this product is overridden in the catalog. If false, the MasterCatalog level SEO content will be used for the product. |
| » seoContent | ProductLocalizedSEOContent | false | none | Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally. |
| »» localeCode | string¦null | false | none | Lanugage used for product content. Currently, only en_US is supported. |
| »» metaTagTitle | string¦null | false | none | Metadata title. Metadata can be used to manage information internally. Sometimes used for SEO. |
| »» metaTagDescription | string¦null | false | none | Metadata description. Metadata can be used to manage information internally. Sometimes used for SEO. |
| »» metaTagKeywords | string¦null | false | none | Metadata keywords. Metadata can be used to manage information internally. Sometimes used for SEO. |
| »» titleTagTitle | string¦null | false | none | Used to customize the HTML title tag within the head section of the product details page |
| »» seoFriendlyUrl | string¦null | false | none | Human-readable identifier that you can give to the product to create friendly URLs. For example, instead of "http: //example.com/products?category=2&id=25," the friendly URL can be "http: //example.com/products/category/2/25." |
| » productCategories | [ProductCategory]¦null | false | none | Categories to which the product belongs for this catalog. |
| »» categoryId | integer(int32) | false | none | Unique identifier of the category. System-supplied and read-only. |
| » primaryProductCategory | ProductCategory | false | none | Categories to which the product belongs. |
| » dateFirstAvailableInCatalog | string(date-time)¦null | false | none | Date this product was first Available for sale in the catalog. This is utilized in expressions that reference DaysInCatloag. |
| » activeDateRange | ActiveDateRange | false | none | Active Effectivity Dates |
| »» startDate | string(date-time)¦null | false | none | none |
| »» endDate | string(date-time)¦null | false | none | none |
| » auditInfo | AuditInfo | false | none | none |
| »» updateDate | string(date-time)¦null | false | none | none |
| »» createDate | string(date-time)¦null | false | none | none |
| »» updateBy | string¦null | false | none | none |
| »» createBy | string¦null | false | none | none |
post_commerce_catalog_admin_products{productCode}_ProductInCatalogs
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/products/{productCode}/ProductInCatalogs \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/products/{productCode}/ProductInCatalogs HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/ProductInCatalogs',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/products/{productCode}/ProductInCatalogs',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/products/{productCode}/ProductInCatalogs', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/products/{productCode}/ProductInCatalogs', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/ProductInCatalogs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/products/{productCode}/ProductInCatalogs", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/products/{productCode}/ProductInCatalogs
Body parameter
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| body | body | ProductInCatalogInfo | false | none |
Example responses
200 Response
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"catalogId":0,"isActive":true,"isContentOverridden":true,"content":{"localeCode":"string","productName":"string","productFullDescription":"string","productShortDescription":"string","productImages":[{"id":0,"localeCode":"string","imageLabel":"string","altText":"string","imageUrl":"string","cmsId":"string","videoUrl":"string","mediaType":"string","sequence":0,"productImageGroupId":"string"}]},"isPriceOverridden":true,"price":{"isoCurrencyCode":"string","price":0,"salePrice":0,"msrp":0,"map":0,"mapStartDate":"2019-08-24T14:15:22Z","mapEndDate":"2019-08-24T14:15:22Z","creditValue":0},"isSeoContentOverridden":true,"seoContent":{"localeCode":"string","metaTagTitle":"string","metaTagDescription":"string","metaTagKeywords":"string","titleTagTitle":"string","seoFriendlyUrl":"string"},"productCategories":[{"categoryId":0}],"primaryProductCategory":{"categoryId":0},"dateFirstAvailableInCatalog":"2019-08-24T14:15:22Z","activeDateRange":{"startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z"},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductInCatalogInfo |
post__commerce_catalog_admin_products_Actions_RenameProductCodes
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/products/Actions/RenameProductCodes \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/products/Actions/RenameProductCodes HTTP/1.1
Content-Type: application/json
const inputBody = '[
{
"existingProductCode": "string",
"newProductCode": "string"
}
]';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/Actions/RenameProductCodes',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/products/Actions/RenameProductCodes',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/products/Actions/RenameProductCodes', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/products/Actions/RenameProductCodes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/Actions/RenameProductCodes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/products/Actions/RenameProductCodes", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/products/Actions/RenameProductCodes
Action that allows productCodes to be Renamed. Changing the resource identifier of a product could cause problems for established products.
Body parameter
[
{
"existingProductCode": "string",
"newProductCode": "string"
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ProductCodeRename | false | An array specifying the existing productCode and the new productCode it should be renamed to |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_products{productCode}_variations
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/variations \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/variations HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/variations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/variations', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/variations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/variations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/variations
Retrieves a paged list of product variations for a specific product according to any specified filter criteria and sort options.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | Merchant-supplied code associated with the product, for example, a SKU. Required. |
| startIndex | query | integer(int32) | false | Used to page results from a query. Indicates the zero-based offset in the complete result set |
| pageSize | query | integer(int32) | false | Used to page results from a query. Indicates the maximum number of entities to return from a |
| sortBy | query | string | false | The element to sort the results by and the order in which the results appear. Either ascending |
| filter | query | string | false | A set of filter expressions representing the search parameters for a query: eq=equals, ne=not |
Detailed descriptions
startIndex: Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0. Optional.
pageSize: Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200. Optional.
sortBy: The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional.
filter: A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"isActive": true,
"isOrphan": true,
"variationExists": true,
"variationkey": "string",
"variationProductCode": "string",
"deltaPrice": {
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
],
"fixedPrice": {
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
},
"localizedFixedPrice": [
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
],
"deltaWeight": 0,
"fixedWeight": 0,
"options": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": null,
"stringValue": null
}
}
],
"upc": "string",
"fulfillmentTypesSupported": [
"string"
],
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
}
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"isActive":true,"isOrphan":true,"variationExists":true,"variationkey":"string","variationProductCode":"string","deltaPrice":{"currencyCode":"string","value":0,"msrp":0,"creditValue":0},"localizedDeltaPrice":[{"currencyCode":"string","value":0,"msrp":0,"creditValue":0}],"fixedPrice":{"currencyCode":"string","listPrice":0,"salePrice":0,"msrp":0,"creditValue":0},"localizedFixedPrice":[{"currencyCode":"string","listPrice":0,"salePrice":0,"msrp":0,"creditValue":0}],"deltaWeight":0,"fixedWeight":0,"options":[{"attributeFQN":"string","value":{},"content":{"localeCode":null,"stringValue":null}}],"upc":"string","fulfillmentTypesSupported":["string"],"supplierInfo":{"mfgPartNumber":"string","distPartNumber":"string","cost":{"isoCurrencyCode":"string","cost":0}}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductVariationPagedCollection |
put_commerce_catalog_admin_products{productCode}_variations
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode}/variations \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode}/variations HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"totalCount": 0,
"items": [
{
"isActive": true,
"isOrphan": true,
"variationExists": true,
"variationkey": "string",
"variationProductCode": "string",
"deltaPrice": {
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
],
"fixedPrice": {
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
},
"localizedFixedPrice": [
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
],
"deltaWeight": 0,
"fixedWeight": 0,
"options": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": null,
"stringValue": null
}
}
],
"upc": "string",
"fulfillmentTypesSupported": [
"string"
],
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
}
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}/variations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}/variations', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}/variations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}/variations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}/variations
Modifies multiple product variations for an existing product in one operation. Use to set IsActive to true for variations that represent configurable options for sale. Also use to change the price or inventory count of an existing product variation. Read-only options are ignored.
Body parameter
{
"totalCount": 0,
"items": [
{
"isActive": true,
"isOrphan": true,
"variationExists": true,
"variationkey": "string",
"variationProductCode": "string",
"deltaPrice": {
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
],
"fixedPrice": {
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
},
"localizedFixedPrice": [
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
],
"deltaWeight": 0,
"fixedWeight": 0,
"options": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": null,
"stringValue": null
}
}
],
"upc": "string",
"fulfillmentTypesSupported": [
"string"
],
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
}
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | Merchant-supplied code associated with the product, for example, a SKU. Required. |
| body | body | ProductVariationCollection | false | Properties of the product variations that you are modifying. Required. |
Example responses
200 Response
{
"totalCount": 0,
"items": [
{
"isActive": true,
"isOrphan": true,
"variationExists": true,
"variationkey": "string",
"variationProductCode": "string",
"deltaPrice": {
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
],
"fixedPrice": {
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
},
"localizedFixedPrice": [
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
],
"deltaWeight": 0,
"fixedWeight": 0,
"options": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": null,
"stringValue": null
}
}
],
"upc": "string",
"fulfillmentTypesSupported": [
"string"
],
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
}
}
]
}
{"totalCount":0,"items":[{"isActive":true,"isOrphan":true,"variationExists":true,"variationkey":"string","variationProductCode":"string","deltaPrice":{"currencyCode":"string","value":0,"msrp":0,"creditValue":0},"localizedDeltaPrice":[{"currencyCode":"string","value":0,"msrp":0,"creditValue":0}],"fixedPrice":{"currencyCode":"string","listPrice":0,"salePrice":0,"msrp":0,"creditValue":0},"localizedFixedPrice":[{"currencyCode":"string","listPrice":0,"salePrice":0,"msrp":0,"creditValue":0}],"deltaWeight":0,"fixedWeight":0,"options":[{"attributeFQN":"string","value":{},"content":{"localeCode":null,"stringValue":null}}],"upc":"string","fulfillmentTypesSupported":["string"],"supplierInfo":{"mfgPartNumber":"string","distPartNumber":"string","cost":{"isoCurrencyCode":"string","cost":0}}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductVariationCollection |
get_commerce_catalog_admin_products{productCode}variations{variationKey}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/variations/{variationKey} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/variations/{variationKey} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/variations/{variationKey}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/variations/{variationKey}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations/{variationKey}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/variations/{variationKey}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/variations/{variationKey}
Retrieves an existing product variation for a specific product and variation key.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | Merchant-created code associated with the product, for example, a SKU. Required. |
| variationKey | path | string | true | Unique identifier for a single product variation. System-supplied and read-only. |
Example responses
200 Response
{
"isActive": true,
"isOrphan": true,
"variationExists": true,
"variationkey": "string",
"variationProductCode": "string",
"deltaPrice": {
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
],
"fixedPrice": {
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
},
"localizedFixedPrice": [
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
],
"deltaWeight": 0,
"fixedWeight": 0,
"options": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
}
}
],
"upc": "string",
"fulfillmentTypesSupported": [
"string"
],
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
}
}
{"isActive":true,"isOrphan":true,"variationExists":true,"variationkey":"string","variationProductCode":"string","deltaPrice":{"currencyCode":"string","value":0,"msrp":0,"creditValue":0},"localizedDeltaPrice":[{"currencyCode":"string","value":0,"msrp":0,"creditValue":0}],"fixedPrice":{"currencyCode":"string","listPrice":0,"salePrice":0,"msrp":0,"creditValue":0},"localizedFixedPrice":[{"currencyCode":"string","listPrice":0,"salePrice":0,"msrp":0,"creditValue":0}],"deltaWeight":0,"fixedWeight":0,"options":[{"attributeFQN":"string","value":{},"content":{"localeCode":"string","stringValue":"string"}}],"upc":"string","fulfillmentTypesSupported":["string"],"supplierInfo":{"mfgPartNumber":"string","distPartNumber":"string","cost":{"isoCurrencyCode":"string","cost":0}}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductVariation |
put_commerce_catalog_admin_products{productCode}variations{variationKey}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode}/variations/{variationKey} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode}/variations/{variationKey} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"isActive": true,
"isOrphan": true,
"variationExists": true,
"variationkey": "string",
"variationProductCode": "string",
"deltaPrice": {
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
],
"fixedPrice": {
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
},
"localizedFixedPrice": [
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
],
"deltaWeight": 0,
"fixedWeight": 0,
"options": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
}
}
],
"upc": "string",
"fulfillmentTypesSupported": [
"string"
],
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}/variations/{variationKey}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}/variations/{variationKey}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations/{variationKey}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}/variations/{variationKey}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}/variations/{variationKey}
Modifies an existing product variation specified by its variation key. Typically used to change the price or inventory count of an existing product variation. Read-only options are ignored.
Body parameter
{
"isActive": true,
"isOrphan": true,
"variationExists": true,
"variationkey": "string",
"variationProductCode": "string",
"deltaPrice": {
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
],
"fixedPrice": {
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
},
"localizedFixedPrice": [
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
],
"deltaWeight": 0,
"fixedWeight": 0,
"options": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
}
}
],
"upc": "string",
"fulfillmentTypesSupported": [
"string"
],
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | Merchant-created code associated with the product, for example, a SKU. Required. |
| variationKey | path | string | true | Unique identifier for a single variation. System-supplied and read-only. |
| body | body | ProductVariation | false | Properties of the product variation that you are modifying. Required. |
Example responses
200 Response
{
"isActive": true,
"isOrphan": true,
"variationExists": true,
"variationkey": "string",
"variationProductCode": "string",
"deltaPrice": {
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
],
"fixedPrice": {
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
},
"localizedFixedPrice": [
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
],
"deltaWeight": 0,
"fixedWeight": 0,
"options": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
}
}
],
"upc": "string",
"fulfillmentTypesSupported": [
"string"
],
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
}
}
{"isActive":true,"isOrphan":true,"variationExists":true,"variationkey":"string","variationProductCode":"string","deltaPrice":{"currencyCode":"string","value":0,"msrp":0,"creditValue":0},"localizedDeltaPrice":[{"currencyCode":"string","value":0,"msrp":0,"creditValue":0}],"fixedPrice":{"currencyCode":"string","listPrice":0,"salePrice":0,"msrp":0,"creditValue":0},"localizedFixedPrice":[{"currencyCode":"string","listPrice":0,"salePrice":0,"msrp":0,"creditValue":0}],"deltaWeight":0,"fixedWeight":0,"options":[{"attributeFQN":"string","value":{},"content":{"localeCode":"string","stringValue":"string"}}],"upc":"string","fulfillmentTypesSupported":["string"],"supplierInfo":{"mfgPartNumber":"string","distPartNumber":"string","cost":{"isoCurrencyCode":"string","cost":0}}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductVariation |
delete_commerce_catalog_admin_products{productCode}variations{variationKey}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/products/{productCode}/variations/{variationKey} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/products/{productCode}/variations/{variationKey} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/products/{productCode}/variations/{variationKey}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/products/{productCode}/variations/{variationKey}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations/{variationKey}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/products/{productCode}/variations/{variationKey}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/products/{productCode}/variations/{variationKey}
Deletes an existing product variation.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | Merchant-created code associated with the product, for example, a SKU. Required. |
| variationKey | path | string | true | Unique identifier for a single product variation. System-supplied and read-only. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_products{productCode}variations{variationKey}_localizedDeltaPrice
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| variationKey | path | string | true | none |
Example responses
200 Response
[
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
]
[{"currencyCode":"string","value":0,"msrp":0,"creditValue":0}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ProductVariationDeltaPrice] | false | none | [How much more a product variation costs above the cost of the base product. If the price of the base product changes, this price is adjusted automatically.] |
| » currencyCode | string¦null | false | none | Which currency is in use. |
| » value | number(double)¦null | false | none | How much more the variation costs above the cost of the base product. |
| » msrp | number(double)¦null | false | none | Manufacturer Suggested Retail Price. |
| » creditValue | number(double)¦null | false | none | Credit amt of the product |
put_commerce_catalog_admin_products{productCode}variations{variationKey}_localizedDeltaPrice
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice
Body parameter
[
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| variationKey | path | string | true | none |
| body | body | ProductVariationDeltaPrice | false | none |
Example responses
200 Response
[
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
]
[{"currencyCode":"string","value":0,"msrp":0,"creditValue":0}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ProductVariationDeltaPrice] | false | none | [How much more a product variation costs above the cost of the base product. If the price of the base product changes, this price is adjusted automatically.] |
| » currencyCode | string¦null | false | none | Which currency is in use. |
| » value | number(double)¦null | false | none | How much more the variation costs above the cost of the base product. |
| » msrp | number(double)¦null | false | none | Manufacturer Suggested Retail Price. |
| » creditValue | number(double)¦null | false | none | Credit amt of the product |
post_commerce_catalog_admin_products{productCode}variations{variationKey}_localizedDeltaPrice
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice
Body parameter
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| variationKey | path | string | true | none |
| body | body | ProductVariationDeltaPrice | false | none |
Example responses
200 Response
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
{"currencyCode":"string","value":0,"msrp":0,"creditValue":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductVariationDeltaPrice |
get_commerce_catalog_admin_products{productCode}variations{variationKey}localizedDeltaPrice{currencyCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| variationKey | path | string | true | none |
| currencyCode | path | string | true | none |
Example responses
200 Response
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
{"currencyCode":"string","value":0,"msrp":0,"creditValue":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductVariationDeltaPrice |
put_commerce_catalog_admin_products{productCode}variations{variationKey}localizedDeltaPrice{currencyCode}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}
Body parameter
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| variationKey | path | string | true | none |
| currencyCode | path | string | true | none |
| body | body | ProductVariationDeltaPrice | false | none |
Example responses
200 Response
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
{"currencyCode":"string","value":0,"msrp":0,"creditValue":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductVariationDeltaPrice |
delete_commerce_catalog_admin_products{productCode}variations{variationKey}localizedDeltaPrice{currencyCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| variationKey | path | string | true | none |
| currencyCode | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_products{productCode}variations{variationKey}_localizedPrice
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| variationKey | path | string | true | none |
Example responses
200 Response
[
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
]
[{"currencyCode":"string","listPrice":0,"salePrice":0,"msrp":0,"creditValue":0}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ProductVariationFixedPrice] | false | none | none |
| » currencyCode | string¦null | false | none | Which currency is in use. |
| » listPrice | number(double)¦null | false | none | Variation price for fixed pricing |
| » salePrice | number(double)¦null | false | none | Variation sale price whne fixed pricing |
| » msrp | number(double)¦null | false | none | Manufacturer Suggested Retail Price. |
| » creditValue | number(double)¦null | false | none | Credit amt of the product |
put_commerce_catalog_admin_products{productCode}variations{variationKey}_localizedPrice
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice
Body parameter
[
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| variationKey | path | string | true | none |
| body | body | ProductVariationFixedPrice | false | none |
Example responses
200 Response
[
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
]
[{"currencyCode":"string","listPrice":0,"salePrice":0,"msrp":0,"creditValue":0}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ProductVariationFixedPrice] | false | none | none |
| » currencyCode | string¦null | false | none | Which currency is in use. |
| » listPrice | number(double)¦null | false | none | Variation price for fixed pricing |
| » salePrice | number(double)¦null | false | none | Variation sale price whne fixed pricing |
| » msrp | number(double)¦null | false | none | Manufacturer Suggested Retail Price. |
| » creditValue | number(double)¦null | false | none | Credit amt of the product |
post_commerce_catalog_admin_products{productCode}variations{variationKey}_localizedPrice
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice
Body parameter
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| variationKey | path | string | true | none |
| body | body | ProductVariationFixedPrice | false | none |
Example responses
200 Response
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
{"currencyCode":"string","listPrice":0,"salePrice":0,"msrp":0,"creditValue":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductVariationFixedPrice |
get_commerce_catalog_admin_products{productCode}variations{variationKey}localizedPrice{currencyCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| variationKey | path | string | true | none |
| currencyCode | path | string | true | none |
Example responses
200 Response
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
{"currencyCode":"string","listPrice":0,"salePrice":0,"msrp":0,"creditValue":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductVariationFixedPrice |
put_commerce_catalog_admin_products{productCode}variations{variationKey}localizedPrice{currencyCode}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}
Body parameter
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| variationKey | path | string | true | none |
| currencyCode | path | string | true | none |
| body | body | ProductVariationFixedPrice | false | none |
Example responses
200 Response
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
{"currencyCode":"string","listPrice":0,"salePrice":0,"msrp":0,"creditValue":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductVariationFixedPrice |
delete_commerce_catalog_admin_products{productCode}variations{variationKey}localizedPrice{currencyCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| variationKey | path | string | true | none |
| currencyCode | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_products{productCode}_Extras
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/Extras \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/Extras HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Extras',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/Extras',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/Extras', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/Extras', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Extras");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/Extras", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/Extras
Get extras for the product
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
Example responses
200 Response
[
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": "string",
"deltaPrice": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"deltaPrice": 0
}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"displayOrder": 0
}
}
]
}
]
[{"attributeFQN":"string","isRequired":true,"isMultiSelect":true,"values":[{"value":{},"deltaPrice":{"currencyCode":"string","deltaPrice":0},"localizedDeltaPrice":[{"currencyCode":"string","deltaPrice":0}],"deltaWeight":0,"isDefaulted":true,"quantity":0,"attributeVocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":null,"stringValue":null},"localizedContent":[{}],"displayOrder":0}}]}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ProductExtra] | false | none | [Product options for configurable or stand-alone products. A configurable option is one that the shopper chooses when ordering, for example, the color of a T-shirt. A stand-alone option is independent of the product and can be added to the product order. For example, a monogram.] |
| » attributeFQN | string¦null | false | none | Unique identifier of the Attribute. |
| » isRequired | boolean¦null | false | none | none |
| » isMultiSelect | boolean¦null | false | none | none |
| » values | [ProductExtraValue]¦null | false | none | [A value of a product option for this product. For example, a computer product may have an option called "Memory" that can have the values "6GB,"8GB," and "12GB."] |
| »» value | object¦null | false | none | none |
| »» deltaPrice | ProductExtraValueDeltaPrice | false | none | How much a product option costs above the cost of the base product, if at all. |
| »»» currencyCode | string¦null | false | none | Which currency to use. |
| »»» deltaPrice | number(double) | false | none | Amount of money saved when discounts are applied. |
| »» localizedDeltaPrice | [ProductExtraValueDeltaPrice]¦null | false | none | [How much a product option costs above the cost of the base product, if at all.] |
| »» deltaWeight | number(double)¦null | false | none | none |
| »» isDefaulted | boolean¦null | false | none | none |
| »» quantity | integer(int32)¦null | false | none | none |
| »» attributeVocabularyValueDetail | AttributeVocabularyValue | false | none | Value of an attribute |
| »»» valueSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence. |
| »»» value | object¦null | false | none | The actual value of the attribute vocabulary. This value must be unique within the vocabulary for a single attribute and match the datatype of the attribute. String data type requires a canonical value here or one will be system generated if null. The actual string content displayed to users should be stored as Content. String values require content to be present. Once this value is set it cannot be changed. |
| »»» mappedGenericValues | [object]¦null | false | none | The actual values of the related generic attribute. This value must match the datatype of the attribute and already exist within the Vocabulary values of the related ValueMappingAttribute. Only supporting string at this time. |
| »»» productName | string¦null | false | none | The ProductName when the Attribute DataType is ProductCode. |
| »»» content | AttributeVocabularyValueLocalizedContent | false | none | Attribute Value Localized Resource |
| »»»» localeCode | string¦null | false | none | Language used for the string attribute value. Currently, only en_US is supported. |
| »»»» stringValue | string¦null | false | none | Localized Value in the language of the locale code |
| »»» localizedContent | [AttributeVocabularyValueLocalizedContent]¦null | false | none | The Content of an attribute value. This content is in multiple locals supported by the master catalog and is only valid for String DataType. |
| »»» displayOrder | integer(int32)¦null | false | none | The order in which the attribute value displays. If you omit a value for this property, Mozu infers the display order from the attribute value's position the list. |
post_commerce_catalog_admin_products{productCode}_Extras
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/products/{productCode}/Extras \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/products/{productCode}/Extras HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": "string",
"deltaPrice": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"deltaPrice": 0
}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Extras',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/products/{productCode}/Extras',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/products/{productCode}/Extras', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/products/{productCode}/Extras', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Extras");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/products/{productCode}/Extras", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/products/{productCode}/Extras
Add extra
Body parameter
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": "string",
"deltaPrice": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"deltaPrice": 0
}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| body | body | ProductExtra | false | none |
Example responses
200 Response
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": "string",
"deltaPrice": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"deltaPrice": 0
}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
{"attributeFQN":"string","isRequired":true,"isMultiSelect":true,"values":[{"value":{},"deltaPrice":{"currencyCode":"string","deltaPrice":0},"localizedDeltaPrice":[{"currencyCode":"string","deltaPrice":0}],"deltaWeight":0,"isDefaulted":true,"quantity":0,"attributeVocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductExtra |
get_commerce_catalog_admin_products{productCode}Extras{attributeFQN}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}
Get individual extra
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
Example responses
200 Response
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": "string",
"deltaPrice": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"deltaPrice": 0
}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
{"attributeFQN":"string","isRequired":true,"isMultiSelect":true,"values":[{"value":{},"deltaPrice":{"currencyCode":"string","deltaPrice":0},"localizedDeltaPrice":[{"currencyCode":"string","deltaPrice":0}],"deltaWeight":0,"isDefaulted":true,"quantity":0,"attributeVocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductExtra |
put_commerce_catalog_admin_products{productCode}Extras{attributeFQN}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": "string",
"deltaPrice": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"deltaPrice": 0
}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}
Update extra
Body parameter
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": "string",
"deltaPrice": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"deltaPrice": 0
}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
| body | body | ProductExtra | false | none |
Example responses
200 Response
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": "string",
"deltaPrice": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"deltaPrice": 0
}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
{"attributeFQN":"string","isRequired":true,"isMultiSelect":true,"values":[{"value":{},"deltaPrice":{"currencyCode":"string","deltaPrice":0},"localizedDeltaPrice":[{"currencyCode":"string","deltaPrice":0}],"deltaWeight":0,"isDefaulted":true,"quantity":0,"attributeVocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductExtra |
delete_commerce_catalog_admin_products{productCode}Extras{attributeFQN}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}
Delete extra
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_products{productCode}Extras{attributeFQN}Values{value}_localizedDeltaPrice
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
Example responses
200 Response
[
{
"currencyCode": "string",
"deltaPrice": 0
}
]
[{"currencyCode":"string","deltaPrice":0}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ProductExtraValueDeltaPrice] | false | none | [How much a product option costs above the cost of the base product, if at all.] |
| » currencyCode | string¦null | false | none | Which currency to use. |
| » deltaPrice | number(double) | false | none | Amount of money saved when discounts are applied. |
put_commerce_catalog_admin_products{productCode}Extras{attributeFQN}Values{value}_localizedDeltaPrice
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"currencyCode": "string",
"deltaPrice": 0
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice
Body parameter
[
{
"currencyCode": "string",
"deltaPrice": 0
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| body | body | ProductExtraValueDeltaPrice | false | none |
Example responses
200 Response
[
{
"currencyCode": "string",
"deltaPrice": 0
}
]
[{"currencyCode":"string","deltaPrice":0}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ProductExtraValueDeltaPrice] | false | none | [How much a product option costs above the cost of the base product, if at all.] |
| » currencyCode | string¦null | false | none | Which currency to use. |
| » deltaPrice | number(double) | false | none | Amount of money saved when discounts are applied. |
post_commerce_catalog_admin_products{productCode}Extras{attributeFQN}Values{value}_localizedDeltaPrice
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"currencyCode": "string",
"deltaPrice": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice
Body parameter
{
"currencyCode": "string",
"deltaPrice": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| body | body | ProductExtraValueDeltaPrice | false | none |
Example responses
200 Response
{
"currencyCode": "string",
"deltaPrice": 0
}
{"currencyCode":"string","deltaPrice":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductExtraValueDeltaPrice |
put_commerce_catalog_admin_products{productCode}Extras{attributeFQN}Values{value}localizedDeltaPrice{currencyCode}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"currencyCode": "string",
"deltaPrice": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}
Body parameter
{
"currencyCode": "string",
"deltaPrice": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| currencyCode | path | string | true | none |
| body | body | ProductExtraValueDeltaPrice | false | none |
Example responses
200 Response
{
"currencyCode": "string",
"deltaPrice": 0
}
{"currencyCode":"string","deltaPrice":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductExtraValueDeltaPrice |
delete_commerce_catalog_admin_products{productCode}Extras{attributeFQN}Values{value}localizedDeltaPrice{currencyCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| currencyCode | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_products{productCode}Extras{attributeFQN}Values{value}localizedDeltaPrice{currencyCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| currencyCode | path | string | true | none |
Example responses
200 Response
{
"currencyCode": "string",
"deltaPrice": 0
}
{"currencyCode":"string","deltaPrice":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductExtraValueDeltaPrice |
get_commerce_catalog_admin_products{ProductCode}_LocationInventory
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{ProductCode}/LocationInventory \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{ProductCode}/LocationInventory HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{ProductCode}/LocationInventory',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{ProductCode}/LocationInventory',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{ProductCode}/LocationInventory', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{ProductCode}/LocationInventory', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{ProductCode}/LocationInventory");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{ProductCode}/LocationInventory", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{ProductCode}/LocationInventory
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| startIndex | query | integer(int32) | false | none |
| pageSize | query | integer(int32) | false | none |
| sortBy | query | string | false | none |
| filter | query | string | false | none |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"locationCode": "string",
"productCode": "string",
"productName": "string",
"stockOnHand": 0,
"stockAvailable": 0,
"stockOnBackOrder": 0,
"baseProductCode": "string",
"sku": "string",
"mfgPartNumber": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"locationCode":"string","productCode":"string","productName":"string","stockOnHand":0,"stockAvailable":0,"stockOnBackOrder":0,"baseProductCode":"string","sku":"string","mfgPartNumber":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | LocationInventoryCollection |
post_commerce_catalog_admin_products{ProductCode}_LocationInventory
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/products/{ProductCode}/LocationInventory \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/products/{ProductCode}/LocationInventory HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"locationCode": "string",
"productCode": "string",
"productName": "string",
"stockOnHand": 0,
"stockAvailable": 0,
"stockOnBackOrder": 0,
"baseProductCode": "string",
"sku": "string",
"mfgPartNumber": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{ProductCode}/LocationInventory',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/products/{ProductCode}/LocationInventory',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/products/{ProductCode}/LocationInventory', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/products/{ProductCode}/LocationInventory', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{ProductCode}/LocationInventory");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/products/{ProductCode}/LocationInventory", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/products/{ProductCode}/LocationInventory
Body parameter
[
{
"locationCode": "string",
"productCode": "string",
"productName": "string",
"stockOnHand": 0,
"stockAvailable": 0,
"stockOnBackOrder": 0,
"baseProductCode": "string",
"sku": "string",
"mfgPartNumber": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| performUpserts | query | boolean | false | none |
| body | body | LocationInventory | false | none |
Example responses
200 Response
[
{
"locationCode": "string",
"productCode": "string",
"productName": "string",
"stockOnHand": 0,
"stockAvailable": 0,
"stockOnBackOrder": 0,
"baseProductCode": "string",
"sku": "string",
"mfgPartNumber": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
[{"locationCode":"string","productCode":"string","productName":"string","stockOnHand":0,"stockAvailable":0,"stockOnBackOrder":0,"baseProductCode":"string","sku":"string","mfgPartNumber":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [LocationInventory] | false | none | [The inventory for a product at a specific Location] |
| » locationCode | string¦null | false | none | none |
| » productCode | string¦null | false | none | none |
| » productName | string¦null | false | none | none |
| » stockOnHand | integer(int32)¦null | false | none | none |
| » stockAvailable | integer(int32)¦null | false | none | none |
| » stockOnBackOrder | integer(int32)¦null | false | none | none |
| » baseProductCode | string¦null | false | none | none |
| » sku | string¦null | false | none | none |
| » mfgPartNumber | string¦null | false | none | none |
| » auditInfo | AuditInfo | false | none | none |
| »» updateDate | string(date-time)¦null | false | none | none |
| »» createDate | string(date-time)¦null | false | none | none |
| »» updateBy | string¦null | false | none | none |
| »» createBy | string¦null | false | none | none |
put_commerce_catalog_admin_products{ProductCode}_LocationInventory
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{ProductCode}/LocationInventory \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{ProductCode}/LocationInventory HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"productCode": "string",
"locationCode": "string",
"type": "string",
"value": 0
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{ProductCode}/LocationInventory',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{ProductCode}/LocationInventory',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{ProductCode}/LocationInventory', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{ProductCode}/LocationInventory', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{ProductCode}/LocationInventory");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{ProductCode}/LocationInventory", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{ProductCode}/LocationInventory
Body parameter
[
{
"productCode": "string",
"locationCode": "string",
"type": "string",
"value": 0
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| body | body | LocationInventoryAdjustment | false | none |
Example responses
200 Response
[
{
"locationCode": "string",
"productCode": "string",
"productName": "string",
"stockOnHand": 0,
"stockAvailable": 0,
"stockOnBackOrder": 0,
"baseProductCode": "string",
"sku": "string",
"mfgPartNumber": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
[{"locationCode":"string","productCode":"string","productName":"string","stockOnHand":0,"stockAvailable":0,"stockOnBackOrder":0,"baseProductCode":"string","sku":"string","mfgPartNumber":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [LocationInventory] | false | none | [The inventory for a product at a specific Location] |
| » locationCode | string¦null | false | none | none |
| » productCode | string¦null | false | none | none |
| » productName | string¦null | false | none | none |
| » stockOnHand | integer(int32)¦null | false | none | none |
| » stockAvailable | integer(int32)¦null | false | none | none |
| » stockOnBackOrder | integer(int32)¦null | false | none | none |
| » baseProductCode | string¦null | false | none | none |
| » sku | string¦null | false | none | none |
| » mfgPartNumber | string¦null | false | none | none |
| » auditInfo | AuditInfo | false | none | none |
| »» updateDate | string(date-time)¦null | false | none | none |
| »» createDate | string(date-time)¦null | false | none | none |
| »» updateBy | string¦null | false | none | none |
| »» createBy | string¦null | false | none | none |
get_commerce_catalog_admin_products{ProductCode}LocationInventory{LocationCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| locationCode | path | string | true | none |
Example responses
200 Response
{
"locationCode": "string",
"productCode": "string",
"productName": "string",
"stockOnHand": 0,
"stockAvailable": 0,
"stockOnBackOrder": 0,
"baseProductCode": "string",
"sku": "string",
"mfgPartNumber": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"locationCode":"string","productCode":"string","productName":"string","stockOnHand":0,"stockAvailable":0,"stockOnBackOrder":0,"baseProductCode":"string","sku":"string","mfgPartNumber":"string","auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | LocationInventory |
delete_commerce_catalog_admin_products{ProductCode}LocationInventory{LocationCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/products/{ProductCode}/LocationInventory/{LocationCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| locationCode | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_products{productCode}_Options
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/Options \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/Options HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Options',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/Options',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/Options', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/Options', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Options");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/Options", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/Options
Get options for the product
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
Example responses
200 Response
[
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"displayOrder": 0
}
}
]
}
]
[{"attributeFQN":"string","isProductImageGroupSelector":true,"values":[{"value":{},"attributeVocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":null,"stringValue":null},"localizedContent":[{}],"displayOrder":0}}]}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ProductOption] | false | none | [Product options for configurable or stand-alone products. A configurable option is one that the shopper chooses when ordering, for example, the color of a T-shirt. A stand-alone option is independent of the product and can be added to the product order. For example, a monogram.] |
| » attributeFQN | string¦null | false | none | Unique identifier of the Attribute. |
| » isProductImageGroupSelector | boolean¦null | false | none | Defines whether or not this option can be used to segment product images |
| » values | [ProductOptionValue]¦null | false | none | List of all the values for this product option. |
| »» value | object¦null | false | none | none |
| »» attributeVocabularyValueDetail | AttributeVocabularyValue | false | none | Value of an attribute |
| »»» valueSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence. |
| »»» value | object¦null | false | none | The actual value of the attribute vocabulary. This value must be unique within the vocabulary for a single attribute and match the datatype of the attribute. String data type requires a canonical value here or one will be system generated if null. The actual string content displayed to users should be stored as Content. String values require content to be present. Once this value is set it cannot be changed. |
| »»» mappedGenericValues | [object]¦null | false | none | The actual values of the related generic attribute. This value must match the datatype of the attribute and already exist within the Vocabulary values of the related ValueMappingAttribute. Only supporting string at this time. |
| »»» productName | string¦null | false | none | The ProductName when the Attribute DataType is ProductCode. |
| »»» content | AttributeVocabularyValueLocalizedContent | false | none | Attribute Value Localized Resource |
| »»»» localeCode | string¦null | false | none | Language used for the string attribute value. Currently, only en_US is supported. |
| »»»» stringValue | string¦null | false | none | Localized Value in the language of the locale code |
| »»» localizedContent | [AttributeVocabularyValueLocalizedContent]¦null | false | none | The Content of an attribute value. This content is in multiple locals supported by the master catalog and is only valid for String DataType. |
| »»» displayOrder | integer(int32)¦null | false | none | The order in which the attribute value displays. If you omit a value for this property, Mozu infers the display order from the attribute value's position the list. |
post_commerce_catalog_admin_products{productCode}_Options
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/products/{productCode}/Options \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/products/{productCode}/Options HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Options',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/products/{productCode}/Options',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/products/{productCode}/Options', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/products/{productCode}/Options', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Options");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/products/{productCode}/Options", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/products/{productCode}/Options
Add option
Body parameter
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| body | body | ProductOption | false | none |
Example responses
200 Response
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
{"attributeFQN":"string","isProductImageGroupSelector":true,"values":[{"value":{},"attributeVocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductOption |
get_commerce_catalog_admin_products{productCode}Options{attributeFQN}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/Options/{attributeFQN} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/Options/{attributeFQN} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}
Get individual option
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
Example responses
200 Response
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
{"attributeFQN":"string","isProductImageGroupSelector":true,"values":[{"value":{},"attributeVocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductOption |
put_commerce_catalog_admin_products{productCode}Options{attributeFQN}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode}/Options/{attributeFQN} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode}/Options/{attributeFQN} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}
Update option
Body parameter
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
| body | body | ProductOption | false | none |
Example responses
200 Response
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
{"attributeFQN":"string","isProductImageGroupSelector":true,"values":[{"value":{},"attributeVocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductOption |
delete_commerce_catalog_admin_products{productCode}Options{attributeFQN}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/products/{productCode}/Options/{attributeFQN} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/products/{productCode}/Options/{attributeFQN} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}
Delete option
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_products{productCode}_Properties
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/Properties \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/Properties HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Properties',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/Properties',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/Properties', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/Properties', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Properties");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/Properties", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/Properties
Get properties for the product
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
Example responses
200 Response
[
{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"displayOrder": 0
}
}
]
}
]
[{"attributeFQN":"string","values":[{"value":{},"content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":"string","stringValue":"string"}],"attributeVocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":null,"stringValue":null},"localizedContent":[{}],"displayOrder":0}}]}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ProductProperty] | false | none | [Product options for configurable or stand-alone products. A configurable option is one that the shopper chooses when ordering, for example, the color of a T-shirt. A stand-alone option is independent of the product and can be added to the product order. For example, a monogram.] |
| » attributeFQN | string¦null | false | none | Unique identifier of the Attribute. |
| » values | [ProductPropertyValue]¦null | false | none | [A value of a product option for this product. For example, a computer product may have an option called "Memory" that can have the values "6GB,"8GB," and "12GB."] |
| »» value | object¦null | false | none | none |
| »» content | ProductPropertyValueLocalizedContent | false | none | Attribute Value Localized Resource |
| »»» localeCode | string¦null | false | none | Language used for the string attribute value. |
| »»» stringValue | string¦null | false | none | Localized Value in the language of the locale code |
| »» localizedContent | [ProductPropertyValueLocalizedContent]¦null | false | none | [Attribute Value Localized Resource] |
| »» attributeVocabularyValueDetail | AttributeVocabularyValue | false | none | Value of an attribute |
| »»» valueSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence. |
| »»» value | object¦null | false | none | The actual value of the attribute vocabulary. This value must be unique within the vocabulary for a single attribute and match the datatype of the attribute. String data type requires a canonical value here or one will be system generated if null. The actual string content displayed to users should be stored as Content. String values require content to be present. Once this value is set it cannot be changed. |
| »»» mappedGenericValues | [object]¦null | false | none | The actual values of the related generic attribute. This value must match the datatype of the attribute and already exist within the Vocabulary values of the related ValueMappingAttribute. Only supporting string at this time. |
| »»» productName | string¦null | false | none | The ProductName when the Attribute DataType is ProductCode. |
| »»» content | AttributeVocabularyValueLocalizedContent | false | none | Attribute Value Localized Resource |
| »»»» localeCode | string¦null | false | none | Language used for the string attribute value. Currently, only en_US is supported. |
| »»»» stringValue | string¦null | false | none | Localized Value in the language of the locale code |
| »»» localizedContent | [AttributeVocabularyValueLocalizedContent]¦null | false | none | The Content of an attribute value. This content is in multiple locals supported by the master catalog and is only valid for String DataType. |
| »»» displayOrder | integer(int32)¦null | false | none | The order in which the attribute value displays. If you omit a value for this property, Mozu infers the display order from the attribute value's position the list. |
post_commerce_catalog_admin_products{productCode}_Properties
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/products/{productCode}/Properties \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/products/{productCode}/Properties HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Properties',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/products/{productCode}/Properties',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/products/{productCode}/Properties', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/products/{productCode}/Properties', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Properties");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/products/{productCode}/Properties", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/products/{productCode}/Properties
Add property
Body parameter
{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| body | body | ProductProperty | false | none |
Example responses
200 Response
{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
{"attributeFQN":"string","values":[{"value":{},"content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":"string","stringValue":"string"}],"attributeVocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductProperty |
get_commerce_catalog_admin_products{productCode}Properties{attributeFQN}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}
Get individual property
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
Example responses
200 Response
{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
{"attributeFQN":"string","values":[{"value":{},"content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":"string","stringValue":"string"}],"attributeVocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductProperty |
put_commerce_catalog_admin_products{productCode}Properties{attributeFQN}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}
Update property
Body parameter
{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
| body | body | ProductProperty | false | none |
Example responses
200 Response
{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
{"attributeFQN":"string","values":[{"value":{},"content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":"string","stringValue":"string"}],"attributeVocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductProperty |
delete_commerce_catalog_admin_products{productCode}Properties{attributeFQN}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}
Delete property
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_products{productCode}Properties{attributeFQN}values{value}_LocalizedContent
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
Example responses
200 Response
[
{
"localeCode": "string",
"stringValue": "string"
}
]
[{"localeCode":"string","stringValue":"string"}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ProductPropertyValueLocalizedContent] | false | none | [Attribute Value Localized Resource] |
| » localeCode | string¦null | false | none | Language used for the string attribute value. |
| » stringValue | string¦null | false | none | Localized Value in the language of the locale code |
post_commerce_catalog_admin_products{productCode}Properties{attributeFQN}values{value}_LocalizedContent
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"localeCode": "string",
"stringValue": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent
Body parameter
{
"localeCode": "string",
"stringValue": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| body | body | ProductPropertyValueLocalizedContent | false | none |
Example responses
200 Response
{
"localeCode": "string",
"stringValue": "string"
}
{"localeCode":"string","stringValue":"string"}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductPropertyValueLocalizedContent |
put_commerce_catalog_admin_products{productCode}Properties{attributeFQN}values{value}_LocalizedContent
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"localeCode": "string",
"stringValue": "string"
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent
Body parameter
[
{
"localeCode": "string",
"stringValue": "string"
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| body | body | ProductPropertyValueLocalizedContent | false | none |
Example responses
200 Response
[
{
"localeCode": "string",
"stringValue": "string"
}
]
[{"localeCode":"string","stringValue":"string"}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ProductPropertyValueLocalizedContent] | false | none | [Attribute Value Localized Resource] |
| » localeCode | string¦null | false | none | Language used for the string attribute value. |
| » stringValue | string¦null | false | none | Localized Value in the language of the locale code |
get_commerce_catalog_admin_products{productCode}Properties{attributeFQN}values{value}LocalizedContent{localeCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| localeCode | path | string | true | none |
Example responses
200 Response
{
"localeCode": "string",
"stringValue": "string"
}
{"localeCode":"string","stringValue":"string"}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductPropertyValueLocalizedContent |
put_commerce_catalog_admin_products{productCode}Properties{attributeFQN}values{value}LocalizedContent{localeCode}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"localeCode": "string",
"stringValue": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}
Body parameter
{
"localeCode": "string",
"stringValue": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| localeCode | path | string | true | none |
| body | body | ProductPropertyValueLocalizedContent | false | none |
Example responses
200 Response
{
"localeCode": "string",
"stringValue": "string"
}
{"localeCode":"string","stringValue":"string"}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductPropertyValueLocalizedContent |
delete_commerce_catalog_admin_products{productCode}Properties{attributeFQN}values{value}LocalizedContent{localeCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent/{localeCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productCode | path | string | true | none |
| attributeFQN | path | string | true | none |
| value | path | string | true | none |
| localeCode | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
ProductSortDefinition
get__commerce_catalog_admin_productsortdefinitions
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/productsortdefinitions \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/productsortdefinitions HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/productsortdefinitions',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/productsortdefinitions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/productsortdefinitions', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/productsortdefinitions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/productsortdefinitions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/productsortdefinitions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/productsortdefinitions
Retrieves a list of product sort definitions according to any specified filter criteria and sort options.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| startIndex | query | integer(int32) | false | Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. The default value is 0. |
| pageSize | query | integer(int32) | false | Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200. |
| sortBy | query | string | false | The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. |
| filter | query | string | false | A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional. |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"productSortDefinitionId": 0,
"categoryId": 0,
"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"sortExpressions": [
{
"field": "string",
"direction": "string"
}
],
"boosted": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"buried": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"productSortDefinitionId":0,"categoryId":0,"name":"string","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","sortExpressions":[{"field":"string","direction":"string"}],"boosted":[{"productCode":"string","sliceValue":"string","position":0,"isPinned":true}],"buried":[{"productCode":"string","sliceValue":"string","position":0,"isPinned":true}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductSortDefinitionPagedCollection |
post__commerce_catalog_admin_productsortdefinitions
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/productsortdefinitions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/productsortdefinitions HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"productSortDefinitionId": 0,
"categoryId": 0,
"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"sortExpressions": [
{
"field": "string",
"direction": "string"
}
],
"boosted": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"buried": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/productsortdefinitions',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/productsortdefinitions',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/productsortdefinitions', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/productsortdefinitions', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/productsortdefinitions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/productsortdefinitions", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/productsortdefinitions
Adds a new product sort definition
Body parameter
{
"productSortDefinitionId": 0,
"categoryId": 0,
"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"sortExpressions": [
{
"field": "string",
"direction": "string"
}
],
"boosted": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"buried": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| useProvidedId | query | boolean | false | If true, the provided Id value will be used as the ProductSortDefinitionId. If omitted or false, the system will generate a ProductSortDefinitionId |
| body | body | ProductSortDefinition | false | Properties of the new product sort definition. Required properties of StartDate and Name. |
Example responses
200 Response
{
"productSortDefinitionId": 0,
"categoryId": 0,
"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"sortExpressions": [
{
"field": "string",
"direction": "string"
}
],
"boosted": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"buried": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"productSortDefinitionId":0,"categoryId":0,"name":"string","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","sortExpressions":[{"field":"string","direction":"string"}],"boosted":[{"productCode":"string","sliceValue":"string","position":0,"isPinned":true}],"buried":[{"productCode":"string","sliceValue":"string","position":0,"isPinned":true}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductSortDefinition |
get_commerce_catalog_admin_productsortdefinitions{productSortDefinitionId}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}
Gets a single product sort definition.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productSortDefinitionId | path | integer(int32) | true | Unique identifier of the product sort definition. |
Example responses
200 Response
{
"productSortDefinitionId": 0,
"categoryId": 0,
"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"sortExpressions": [
{
"field": "string",
"direction": "string"
}
],
"boosted": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"buried": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"productSortDefinitionId":0,"categoryId":0,"name":"string","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","sortExpressions":[{"field":"string","direction":"string"}],"boosted":[{"productCode":"string","sliceValue":"string","position":0,"isPinned":true}],"buried":[{"productCode":"string","sliceValue":"string","position":0,"isPinned":true}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductSortDefinition |
put_commerce_catalog_admin_productsortdefinitions{productSortDefinitionId}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"productSortDefinitionId": 0,
"categoryId": 0,
"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"sortExpressions": [
{
"field": "string",
"direction": "string"
}
],
"boosted": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"buried": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}
Updates the details of a product sort definition
Body parameter
{
"productSortDefinitionId": 0,
"categoryId": 0,
"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"sortExpressions": [
{
"field": "string",
"direction": "string"
}
],
"boosted": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"buried": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productSortDefinitionId | path | integer(int32) | true | Unique identifier of the product sort definition. |
| body | body | ProductSortDefinition | false | The details of the product sort definition to update. |
Example responses
200 Response
{
"productSortDefinitionId": 0,
"categoryId": 0,
"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"sortExpressions": [
{
"field": "string",
"direction": "string"
}
],
"boosted": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"buried": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"productSortDefinitionId":0,"categoryId":0,"name":"string","startDate":"2019-08-24T14:15:22Z","endDate":"2019-08-24T14:15:22Z","sortExpressions":[{"field":"string","direction":"string"}],"boosted":[{"productCode":"string","sliceValue":"string","position":0,"isPinned":true}],"buried":[{"productCode":"string","sliceValue":"string","position":0,"isPinned":true}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductSortDefinition |
delete_commerce_catalog_admin_productsortdefinitions{productSortDefinitionId}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/productsortdefinitions/{productSortDefinitionId}
Deletes the product sort definition specified by its ProductSortDefinitionID.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productSortDefinitionId | path | integer(int32) | true | Unique identifier of the product sort definition. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
ProductType
get__commerce_catalog_admin_attributedefinition_producttypes
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/producttypes \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/producttypes HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/producttypes',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/producttypes', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/producttypes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/producttypes", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/producttypes
Retrieves a list of product types according to any specified filter criteria and sort options.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| startIndex | query | integer(int32) | false | Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0. |
| pageSize | query | integer(int32) | false | Used to page results from a query. Indicates the maximum number of entities to return from a single query. The default value is 20 and the maximum value is 200. |
| sortBy | query | string | false | The element to sort the results by and the order in which the results appear. Either ascending or descending order. For example, to sort the results by “ID” ascending then by “CreateDate” descending, use: id asc,createdate desc. |
| filter | query | string | false | A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional. |
| responseGroups | query | string | false | Used to get more specific information from the request. For example to get discounts applied to a product use the AppliedProducts response group. Available response groups: ApplicableDiscounts, VariationOptions, and BaseProductCode. |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"id": 0,
"name": "string",
"masterCatalogId": 0,
"isBaseProductType": true,
"productCount": 0,
"productUsages": [
"string"
],
"goodsType": "string",
"options": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": null
},
"vocabularyValues": [
{}
],
"attributeDetail": {
"adminName": null,
"namespace": null,
"attributeCode": null,
"attributeFQN": null,
"isValueMappingAttribute": null,
"valueMappingAttributeFQN": null,
"attributeSequence": null,
"attributeDataTypeSequence": null,
"masterCatalogId": null,
"inputType": null,
"valueType": null,
"dataType": null,
"isOption": null,
"isExtra": null,
"isProperty": null,
"attributeMetadata": null,
"content": null,
"localizedContent": null,
"validation": null,
"vocabularyValues": null,
"searchSettings": null,
"auditInfo": null
}
}
],
"extras": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": null
},
"vocabularyValues": [
{}
],
"attributeDetail": {
"adminName": null,
"namespace": null,
"attributeCode": null,
"attributeFQN": null,
"isValueMappingAttribute": null,
"valueMappingAttributeFQN": null,
"attributeSequence": null,
"attributeDataTypeSequence": null,
"masterCatalogId": null,
"inputType": null,
"valueType": null,
"dataType": null,
"isOption": null,
"isExtra": null,
"isProperty": null,
"attributeMetadata": null,
"content": null,
"localizedContent": null,
"validation": null,
"vocabularyValues": null,
"searchSettings": null,
"auditInfo": null
}
}
],
"properties": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": null
},
"vocabularyValues": [
{}
],
"attributeDetail": {
"adminName": null,
"namespace": null,
"attributeCode": null,
"attributeFQN": null,
"isValueMappingAttribute": null,
"valueMappingAttributeFQN": null,
"attributeSequence": null,
"attributeDataTypeSequence": null,
"masterCatalogId": null,
"inputType": null,
"valueType": null,
"dataType": null,
"isOption": null,
"isExtra": null,
"isProperty": null,
"attributeMetadata": null,
"content": null,
"localizedContent": null,
"validation": null,
"vocabularyValues": null,
"searchSettings": null,
"auditInfo": null
}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"id":0,"name":"string","masterCatalogId":0,"isBaseProductType":true,"productCount":0,"productUsages":["string"],"goodsType":"string","options":[{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":null},"vocabularyValues":[{}],"attributeDetail":{"adminName":null,"namespace":null,"attributeCode":null,"attributeFQN":null,"isValueMappingAttribute":null,"valueMappingAttributeFQN":null,"attributeSequence":null,"attributeDataTypeSequence":null,"masterCatalogId":null,"inputType":null,"valueType":null,"dataType":null,"isOption":null,"isExtra":null,"isProperty":null,"attributeMetadata":null,"content":null,"localizedContent":null,"validation":null,"vocabularyValues":null,"searchSettings":null,"auditInfo":null}}],"extras":[{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":null},"vocabularyValues":[{}],"attributeDetail":{"adminName":null,"namespace":null,"attributeCode":null,"attributeFQN":null,"isValueMappingAttribute":null,"valueMappingAttributeFQN":null,"attributeSequence":null,"attributeDataTypeSequence":null,"masterCatalogId":null,"inputType":null,"valueType":null,"dataType":null,"isOption":null,"isExtra":null,"isProperty":null,"attributeMetadata":null,"content":null,"localizedContent":null,"validation":null,"vocabularyValues":null,"searchSettings":null,"auditInfo":null}}],"properties":[{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":null},"vocabularyValues":[{}],"attributeDetail":{"adminName":null,"namespace":null,"attributeCode":null,"attributeFQN":null,"isValueMappingAttribute":null,"valueMappingAttributeFQN":null,"attributeSequence":null,"attributeDataTypeSequence":null,"masterCatalogId":null,"inputType":null,"valueType":null,"dataType":null,"isOption":null,"isExtra":null,"isProperty":null,"attributeMetadata":null,"content":null,"localizedContent":null,"validation":null,"vocabularyValues":null,"searchSettings":null,"auditInfo":null}}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductTypeCollection |
post__commerce_catalog_admin_attributedefinition_producttypes
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/attributedefinition/producttypes \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/attributedefinition/producttypes HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"id": 0,
"name": "string",
"masterCatalogId": 0,
"isBaseProductType": true,
"productCount": 0,
"productUsages": [
"string"
],
"goodsType": "string",
"options": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"extras": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"properties": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/attributedefinition/producttypes',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/attributedefinition/producttypes', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/attributedefinition/producttypes', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/attributedefinition/producttypes", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/attributedefinition/producttypes
Add or create product type
Body parameter
{
"id": 0,
"name": "string",
"masterCatalogId": 0,
"isBaseProductType": true,
"productCount": 0,
"productUsages": [
"string"
],
"goodsType": "string",
"options": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"extras": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"properties": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ProductType | false | none |
Example responses
200 Response
{
"id": 0,
"name": "string",
"masterCatalogId": 0,
"isBaseProductType": true,
"productCount": 0,
"productUsages": [
"string"
],
"goodsType": "string",
"options": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"extras": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"properties": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"id":0,"name":"string","masterCatalogId":0,"isBaseProductType":true,"productCount":0,"productUsages":["string"],"goodsType":"string","options":[{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":null,"imageUrl":null,"colorValue":null},"vocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":null,"value":null}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":null,"name":null,"description":null}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}],"extras":[{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":null,"imageUrl":null,"colorValue":null},"vocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":null,"value":null}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":null,"name":null,"description":null}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}],"properties":[{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":null,"imageUrl":null,"colorValue":null},"vocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":null,"value":null}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":null,"name":null,"description":null}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductType |
get_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}
Get product type by Id
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
Example responses
200 Response
{
"id": 0,
"name": "string",
"masterCatalogId": 0,
"isBaseProductType": true,
"productCount": 0,
"productUsages": [
"string"
],
"goodsType": "string",
"options": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"extras": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"properties": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"id":0,"name":"string","masterCatalogId":0,"isBaseProductType":true,"productCount":0,"productUsages":["string"],"goodsType":"string","options":[{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":null,"imageUrl":null,"colorValue":null},"vocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":null,"value":null}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":null,"name":null,"description":null}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}],"extras":[{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":null,"imageUrl":null,"colorValue":null},"vocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":null,"value":null}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":null,"name":null,"description":null}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}],"properties":[{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":null,"imageUrl":null,"colorValue":null},"vocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":null,"value":null}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":null,"name":null,"description":null}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductType |
put_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"id": 0,
"name": "string",
"masterCatalogId": 0,
"isBaseProductType": true,
"productCount": 0,
"productUsages": [
"string"
],
"goodsType": "string",
"options": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"extras": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"properties": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}
Update product type
Body parameter
{
"id": 0,
"name": "string",
"masterCatalogId": 0,
"isBaseProductType": true,
"productCount": 0,
"productUsages": [
"string"
],
"goodsType": "string",
"options": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"extras": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"properties": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
| body | body | ProductType | false | none |
Example responses
200 Response
{
"id": 0,
"name": "string",
"masterCatalogId": 0,
"isBaseProductType": true,
"productCount": 0,
"productUsages": [
"string"
],
"goodsType": "string",
"options": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"extras": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"properties": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"id":0,"name":"string","masterCatalogId":0,"isBaseProductType":true,"productCount":0,"productUsages":["string"],"goodsType":"string","options":[{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":null,"imageUrl":null,"colorValue":null},"vocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":null,"value":null}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":null,"name":null,"description":null}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}],"extras":[{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":null,"imageUrl":null,"colorValue":null},"vocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":null,"value":null}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":null,"name":null,"description":null}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}],"properties":[{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":null,"imageUrl":null,"colorValue":null},"vocabularyValueDetail":{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":null,"value":null}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":null,"name":null,"description":null}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":null,"value":null,"mappedGenericValues":null,"productName":null,"content":null,"localizedContent":null,"displayOrder":null}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductType |
delete_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}
Delete product type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
post_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}_variations
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/variations \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/variations HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '[
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"displayOrder": 0
}
}
]
}
]';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/variations',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/variations',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/variations', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/variations', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/variations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/variations", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/variations
Body parameter
[
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"displayOrder": 0
}
}
]
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
| productCode | query | string | false | none |
| startIndex | query | integer(int32) | false | none |
| pageSize | query | integer(int32) | false | none |
| sortBy | query | string | false | none |
| filter | query | string | false | none |
| body | body | ProductOption | false | none |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"isActive": true,
"isOrphan": true,
"variationExists": true,
"variationkey": "string",
"variationProductCode": "string",
"deltaPrice": {
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
],
"fixedPrice": {
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
},
"localizedFixedPrice": [
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
],
"deltaWeight": 0,
"fixedWeight": 0,
"options": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": null,
"stringValue": null
}
}
],
"upc": "string",
"fulfillmentTypesSupported": [
"string"
],
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
}
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"isActive":true,"isOrphan":true,"variationExists":true,"variationkey":"string","variationProductCode":"string","deltaPrice":{"currencyCode":"string","value":0,"msrp":0,"creditValue":0},"localizedDeltaPrice":[{"currencyCode":"string","value":0,"msrp":0,"creditValue":0}],"fixedPrice":{"currencyCode":"string","listPrice":0,"salePrice":0,"msrp":0,"creditValue":0},"localizedFixedPrice":[{"currencyCode":"string","listPrice":0,"salePrice":0,"msrp":0,"creditValue":0}],"deltaWeight":0,"fixedWeight":0,"options":[{"attributeFQN":"string","value":{},"content":{"localeCode":null,"stringValue":null}}],"upc":"string","fulfillmentTypesSupported":["string"],"supplierInfo":{"mfgPartNumber":"string","distPartNumber":"string","cost":{"isoCurrencyCode":"string","cost":0}}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductVariationPagedCollection |
get_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}_Extras
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras
Get extras
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
Example responses
200 Response
[
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
]
[{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":"string","imageUrl":"string","colorValue":"string"},"vocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":null,"stringValue":null},"localizedContent":[{}],"displayOrder":0}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":null,"stringValue":null},"localizedContent":[{}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [AttributeInProductType] | false | none | none |
| » attributeFQN | string¦null | false | none | Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed |
| » isInheritedFromBaseType | boolean¦null | false | none | If True, the attribute is part of the base product type and can only have order modified. |
| » order | integer(int32)¦null | false | none | Used to order the display of the attributes within a section |
| » isRequiredByAdmin | boolean¦null | false | none | If True, the admin must include this attribute in products of this productType |
| » isHiddenProperty | boolean¦null | false | none | If True, the property is hidden in the storefront. This field only applies to properties. |
| » isAdminOnlyProperty | boolean¦null | false | none | If true, this property is not available on the storefront. If false, this property will be available on storefront. The IsHiddenProperty hides the property from the customer, but is still available from the API. |
| » isProductDetailsOnlyProperty | boolean¦null | false | none | If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...) |
| » isMultiValueProperty | boolean¦null | false | none | If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties. |
| » displayInfo | AttributeInProductTypeDisplayInfo | false | none | none |
| »» displayIntention | string¦null | false | none | Defines the intended display of this Attribute in the storeFront (ex. DropDown, ImagePicker, RadioButtons....) |
| » vocabularyValues | [AttributeVocabularyValueInProductType]¦null | false | none | The collection of vocabulary values included in this product type. |
| »» value | object¦null | false | none | The actual value of the attribute vocabulary. This must be an existing value defined in the attribute vocabulary |
| »» order | integer(int32)¦null | false | none | Used to order the display of the attribute values in the storefront.... |
| »» displayInfo | AttributeVocabularyValueDisplayInfo | false | none | none |
| »»» cmsId | string¦null | false | none | Id of the image in the CMS. |
| »»» imageUrl | string¦null | false | none | URL of the image. |
| »»» colorValue | string¦null | false | none | Hex Color value to display in a color picker |
| »» vocabularyValueDetail | AttributeVocabularyValue | false | none | Value of an attribute |
| »»» valueSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence. |
| »»» value | object¦null | false | none | The actual value of the attribute vocabulary. This value must be unique within the vocabulary for a single attribute and match the datatype of the attribute. String data type requires a canonical value here or one will be system generated if null. The actual string content displayed to users should be stored as Content. String values require content to be present. Once this value is set it cannot be changed. |
| »»» mappedGenericValues | [object]¦null | false | none | The actual values of the related generic attribute. This value must match the datatype of the attribute and already exist within the Vocabulary values of the related ValueMappingAttribute. Only supporting string at this time. |
| »»» productName | string¦null | false | none | The ProductName when the Attribute DataType is ProductCode. |
| »»» content | AttributeVocabularyValueLocalizedContent | false | none | Attribute Value Localized Resource |
| »»»» localeCode | string¦null | false | none | Language used for the string attribute value. Currently, only en_US is supported. |
| »»»» stringValue | string¦null | false | none | Localized Value in the language of the locale code |
| »»» localizedContent | [AttributeVocabularyValueLocalizedContent]¦null | false | none | The Content of an attribute value. This content is in multiple locals supported by the master catalog and is only valid for String DataType. |
| »»» displayOrder | integer(int32)¦null | false | none | The order in which the attribute value displays. If you omit a value for this property, Mozu infers the display order from the attribute value's position the list. |
| » attributeDetail | Attribute | false | none | Attribute |
| »» adminName | string¦null | false | none | Name of the product displayed in the admin, This field does not need to be unqiue, but is required. It can include spaces...and is limited to a length of 50. |
| »» namespace | string¦null | false | none | NameSpace, each application creating attributes will have a uniqe namespace to avoid name (Code) collisions. The namespace provided must be a valid registered namespace. If no namespace is specified it is assumed to be the namespace of the Tenant. |
| »» attributeCode | string¦null | false | none | Unique identifier of the Attribute. Must be unique within a namespace and cannot be changed once the attribute is created. This value will be generated and match the attribute sequence if not provided on create. |
| »» attributeFQN | string¦null | false | none | Attribute fully qualified name, Read only value that combines namespace and attribute code as NameSpace~AttributeCode |
| »» isValueMappingAttribute | boolean¦null | false | none | Specifies if this attribute can can be used to generalize values of another attribute |
| »» valueMappingAttributeFQN | string¦null | false | none | Attribute fully qualified name of a corresponding value mapping atribuite |
| »» attributeSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence for each attribute created. |
| »» attributeDataTypeSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence for each attribute,DataType created (this is used to optimize indexed field names in search). |
| »» masterCatalogId | integer(int32)¦null | false | none | Indentifier of the master that this attribute is a member of. System-supplied and read-only. Attributes will be created in the MasterCatalog of the supplied context. |
| »» inputType | string¦null | false | none | The InputType type of the attribute. Must be a valid value for InputType defined in InputTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create |
| »» valueType | string¦null | false | none | The ValueType of the attribute. Must be a valid value for ValueType defined in ValueTypeTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create |
| »» dataType | string¦null | false | none | The DataType of the attribute. Must be a valid value for DataType defined in DataTypeTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create |
| »» isOption | boolean¦null | false | none | Specifies if this attribute can have a usage type of Option in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource. |
| »» isExtra | boolean¦null | false | none | Specifies if this attribute can have a usage type of Extra in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource. |
| »» isProperty | boolean¦null | false | none | Specifies if this attribute can have a usage type of Property in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource. |
| »» attributeMetadata | [AttributeMetadataItem]¦null | false | none | Attribute Metadata. This list can contain opaque data (key value pairs) that can be used as a property bag for UI concerns. |
| »»» key | string¦null | false | none | none |
| »»» value | string¦null | false | none | none |
| »» content | AttributeLocalizedContent | false | none | Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display an attribute in multiple languages yet manage it as a single attribute internally. |
| »»» localeCode | string¦null | false | none | Language used for the attribute name and description. Currently, only en_US is supported. |
| »»» name | string¦null | false | none | Name of the attribute in the language specified by LocaleCode. |
| »»» description | string¦null | false | none | Description of the attribute in the language specified by LocaleCode. |
| »» localizedContent | [AttributeLocalizedContent]¦null | false | none | The Content of an attribute. This content is always in the default language of the MasterCatalog. |
| »» validation | AttributeValidation | false | none | Used to validate attributes. |
| »»» regularExpression | string¦null | false | none | Regular expression to run against the attribute value. This should follow JavaScript/EMCA's Regular Expression syntax. |
| »»» minStringLength | integer(int32)¦null | false | none | For validating strings, minimum length allowed for a string. |
| »»» maxStringLength | integer(int32)¦null | false | none | For validating strings, maximum length allowed for a string. |
| »»» minNumericValue | number(double)¦null | false | none | For validating Number attribute value, minimum number allowed. |
| »»» maxNumericValue | number(double)¦null | false | none | For validating Number attribute value, maximum number allowed. |
| »»» minDateValue | string(date-time)¦null | false | none | For validating a DateTime attribute value, minimum datetime allowed. |
| »»» maxDateValue | string(date-time)¦null | false | none | For validating a DateTime attribute value, maximum datetime allowed. |
| »» vocabularyValues | [AttributeVocabularyValue]¦null | false | none | The list of Values for this attribute. Only available for ValueType:PredefinedVocabulary |
| »» searchSettings | AttributeSearchSettings | false | none | Attribute Search Settings. A container for all of the search and indexing settings of an Attribute |
| »»» searchableInStorefront | boolean | false | none | Indicates whether the attribute value should be searchable on the public storefront. |
| »»» searchableInAdmin | boolean | false | none | Indicates whether the attribute value should be searchable in the merchant catalog admin. |
| »»» searchDisplayValue | boolean | false | none | If true, the system will index the display value of string attributes instead of the canonical value for searching. The canonical value will always be used for filtering. Does not apply for for non-string attributes. |
| »»» allowFilteringAndSortingInStorefront | boolean¦null | false | none | Indicates whether the attribute should be able to be used in filters, facets, and sorting on the public storefront. |
| »»» indexValueWithCase | boolean¦null | false | none | Indicates whether the attribute value is case sensative for filtering and faceting. This applies to Text Admin entered attributes. A null value means it is not case sensative |
| »»» customWeightInStorefrontSearch | boolean¦null | false | none | Indicates whether the attribute is indevidually stored as a tokenized field in search for custom term search weight |
| »» auditInfo | AuditInfo | false | none | none |
| »»» updateDate | string(date-time)¦null | false | none | none |
| »»» createDate | string(date-time)¦null | false | none | none |
| »»» updateBy | string¦null | false | none | none |
| »»» createBy | string¦null | false | none | none |
post_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}_Extras
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras
Add extra
Body parameter
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
| body | body | AttributeInProductType | false | none |
Example responses
200 Response
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":"string","imageUrl":"string","colorValue":"string"},"vocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeInProductType |
get_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}Extras{attributeFQN}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}
Get extra
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
| attributeFQN | path | string | true | none |
Example responses
200 Response
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":"string","imageUrl":"string","colorValue":"string"},"vocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeInProductType |
put_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}Extras{attributeFQN}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}
Update extra
Body parameter
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
| attributeFQN | path | string | true | none |
| body | body | AttributeInProductType | false | none |
Example responses
200 Response
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":"string","imageUrl":"string","colorValue":"string"},"vocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeInProductType |
delete_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}Extras{attributeFQN}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}
Delete extra
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
| attributeFQN | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}_Options
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options
Get options for the product type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
Example responses
200 Response
[
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
]
[{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":"string","imageUrl":"string","colorValue":"string"},"vocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":null,"stringValue":null},"localizedContent":[{}],"displayOrder":0}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":null,"stringValue":null},"localizedContent":[{}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [AttributeInProductType] | false | none | none |
| » attributeFQN | string¦null | false | none | Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed |
| » isInheritedFromBaseType | boolean¦null | false | none | If True, the attribute is part of the base product type and can only have order modified. |
| » order | integer(int32)¦null | false | none | Used to order the display of the attributes within a section |
| » isRequiredByAdmin | boolean¦null | false | none | If True, the admin must include this attribute in products of this productType |
| » isHiddenProperty | boolean¦null | false | none | If True, the property is hidden in the storefront. This field only applies to properties. |
| » isAdminOnlyProperty | boolean¦null | false | none | If true, this property is not available on the storefront. If false, this property will be available on storefront. The IsHiddenProperty hides the property from the customer, but is still available from the API. |
| » isProductDetailsOnlyProperty | boolean¦null | false | none | If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...) |
| » isMultiValueProperty | boolean¦null | false | none | If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties. |
| » displayInfo | AttributeInProductTypeDisplayInfo | false | none | none |
| »» displayIntention | string¦null | false | none | Defines the intended display of this Attribute in the storeFront (ex. DropDown, ImagePicker, RadioButtons....) |
| » vocabularyValues | [AttributeVocabularyValueInProductType]¦null | false | none | The collection of vocabulary values included in this product type. |
| »» value | object¦null | false | none | The actual value of the attribute vocabulary. This must be an existing value defined in the attribute vocabulary |
| »» order | integer(int32)¦null | false | none | Used to order the display of the attribute values in the storefront.... |
| »» displayInfo | AttributeVocabularyValueDisplayInfo | false | none | none |
| »»» cmsId | string¦null | false | none | Id of the image in the CMS. |
| »»» imageUrl | string¦null | false | none | URL of the image. |
| »»» colorValue | string¦null | false | none | Hex Color value to display in a color picker |
| »» vocabularyValueDetail | AttributeVocabularyValue | false | none | Value of an attribute |
| »»» valueSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence. |
| »»» value | object¦null | false | none | The actual value of the attribute vocabulary. This value must be unique within the vocabulary for a single attribute and match the datatype of the attribute. String data type requires a canonical value here or one will be system generated if null. The actual string content displayed to users should be stored as Content. String values require content to be present. Once this value is set it cannot be changed. |
| »»» mappedGenericValues | [object]¦null | false | none | The actual values of the related generic attribute. This value must match the datatype of the attribute and already exist within the Vocabulary values of the related ValueMappingAttribute. Only supporting string at this time. |
| »»» productName | string¦null | false | none | The ProductName when the Attribute DataType is ProductCode. |
| »»» content | AttributeVocabularyValueLocalizedContent | false | none | Attribute Value Localized Resource |
| »»»» localeCode | string¦null | false | none | Language used for the string attribute value. Currently, only en_US is supported. |
| »»»» stringValue | string¦null | false | none | Localized Value in the language of the locale code |
| »»» localizedContent | [AttributeVocabularyValueLocalizedContent]¦null | false | none | The Content of an attribute value. This content is in multiple locals supported by the master catalog and is only valid for String DataType. |
| »»» displayOrder | integer(int32)¦null | false | none | The order in which the attribute value displays. If you omit a value for this property, Mozu infers the display order from the attribute value's position the list. |
| » attributeDetail | Attribute | false | none | Attribute |
| »» adminName | string¦null | false | none | Name of the product displayed in the admin, This field does not need to be unqiue, but is required. It can include spaces...and is limited to a length of 50. |
| »» namespace | string¦null | false | none | NameSpace, each application creating attributes will have a uniqe namespace to avoid name (Code) collisions. The namespace provided must be a valid registered namespace. If no namespace is specified it is assumed to be the namespace of the Tenant. |
| »» attributeCode | string¦null | false | none | Unique identifier of the Attribute. Must be unique within a namespace and cannot be changed once the attribute is created. This value will be generated and match the attribute sequence if not provided on create. |
| »» attributeFQN | string¦null | false | none | Attribute fully qualified name, Read only value that combines namespace and attribute code as NameSpace~AttributeCode |
| »» isValueMappingAttribute | boolean¦null | false | none | Specifies if this attribute can can be used to generalize values of another attribute |
| »» valueMappingAttributeFQN | string¦null | false | none | Attribute fully qualified name of a corresponding value mapping atribuite |
| »» attributeSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence for each attribute created. |
| »» attributeDataTypeSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence for each attribute,DataType created (this is used to optimize indexed field names in search). |
| »» masterCatalogId | integer(int32)¦null | false | none | Indentifier of the master that this attribute is a member of. System-supplied and read-only. Attributes will be created in the MasterCatalog of the supplied context. |
| »» inputType | string¦null | false | none | The InputType type of the attribute. Must be a valid value for InputType defined in InputTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create |
| »» valueType | string¦null | false | none | The ValueType of the attribute. Must be a valid value for ValueType defined in ValueTypeTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create |
| »» dataType | string¦null | false | none | The DataType of the attribute. Must be a valid value for DataType defined in DataTypeTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create |
| »» isOption | boolean¦null | false | none | Specifies if this attribute can have a usage type of Option in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource. |
| »» isExtra | boolean¦null | false | none | Specifies if this attribute can have a usage type of Extra in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource. |
| »» isProperty | boolean¦null | false | none | Specifies if this attribute can have a usage type of Property in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource. |
| »» attributeMetadata | [AttributeMetadataItem]¦null | false | none | Attribute Metadata. This list can contain opaque data (key value pairs) that can be used as a property bag for UI concerns. |
| »»» key | string¦null | false | none | none |
| »»» value | string¦null | false | none | none |
| »» content | AttributeLocalizedContent | false | none | Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display an attribute in multiple languages yet manage it as a single attribute internally. |
| »»» localeCode | string¦null | false | none | Language used for the attribute name and description. Currently, only en_US is supported. |
| »»» name | string¦null | false | none | Name of the attribute in the language specified by LocaleCode. |
| »»» description | string¦null | false | none | Description of the attribute in the language specified by LocaleCode. |
| »» localizedContent | [AttributeLocalizedContent]¦null | false | none | The Content of an attribute. This content is always in the default language of the MasterCatalog. |
| »» validation | AttributeValidation | false | none | Used to validate attributes. |
| »»» regularExpression | string¦null | false | none | Regular expression to run against the attribute value. This should follow JavaScript/EMCA's Regular Expression syntax. |
| »»» minStringLength | integer(int32)¦null | false | none | For validating strings, minimum length allowed for a string. |
| »»» maxStringLength | integer(int32)¦null | false | none | For validating strings, maximum length allowed for a string. |
| »»» minNumericValue | number(double)¦null | false | none | For validating Number attribute value, minimum number allowed. |
| »»» maxNumericValue | number(double)¦null | false | none | For validating Number attribute value, maximum number allowed. |
| »»» minDateValue | string(date-time)¦null | false | none | For validating a DateTime attribute value, minimum datetime allowed. |
| »»» maxDateValue | string(date-time)¦null | false | none | For validating a DateTime attribute value, maximum datetime allowed. |
| »» vocabularyValues | [AttributeVocabularyValue]¦null | false | none | The list of Values for this attribute. Only available for ValueType:PredefinedVocabulary |
| »» searchSettings | AttributeSearchSettings | false | none | Attribute Search Settings. A container for all of the search and indexing settings of an Attribute |
| »»» searchableInStorefront | boolean | false | none | Indicates whether the attribute value should be searchable on the public storefront. |
| »»» searchableInAdmin | boolean | false | none | Indicates whether the attribute value should be searchable in the merchant catalog admin. |
| »»» searchDisplayValue | boolean | false | none | If true, the system will index the display value of string attributes instead of the canonical value for searching. The canonical value will always be used for filtering. Does not apply for for non-string attributes. |
| »»» allowFilteringAndSortingInStorefront | boolean¦null | false | none | Indicates whether the attribute should be able to be used in filters, facets, and sorting on the public storefront. |
| »»» indexValueWithCase | boolean¦null | false | none | Indicates whether the attribute value is case sensative for filtering and faceting. This applies to Text Admin entered attributes. A null value means it is not case sensative |
| »»» customWeightInStorefrontSearch | boolean¦null | false | none | Indicates whether the attribute is indevidually stored as a tokenized field in search for custom term search weight |
| »» auditInfo | AuditInfo | false | none | none |
| »»» updateDate | string(date-time)¦null | false | none | none |
| »»» createDate | string(date-time)¦null | false | none | none |
| »»» updateBy | string¦null | false | none | none |
| »»» createBy | string¦null | false | none | none |
post_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}_Options
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options
Add option
Body parameter
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
| body | body | AttributeInProductType | false | none |
Example responses
200 Response
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":"string","imageUrl":"string","colorValue":"string"},"vocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeInProductType |
get_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}Options{attributeFQN}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}
Get individual option
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
| attributeFQN | path | string | true | none |
Example responses
200 Response
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":"string","imageUrl":"string","colorValue":"string"},"vocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeInProductType |
put_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}Options{attributeFQN}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}
Update option
Body parameter
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
| attributeFQN | path | string | true | none |
| body | body | AttributeInProductType | false | none |
Example responses
200 Response
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":"string","imageUrl":"string","colorValue":"string"},"vocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeInProductType |
delete_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}Options{attributeFQN}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Options/{attributeFQN}
Delete option
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
| attributeFQN | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}_Properties
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties
Get properties
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
Example responses
200 Response
[
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
]
[{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":"string","imageUrl":"string","colorValue":"string"},"vocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":null,"stringValue":null},"localizedContent":[{}],"displayOrder":0}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":null,"stringValue":null},"localizedContent":[{}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [AttributeInProductType] | false | none | none |
| » attributeFQN | string¦null | false | none | Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed |
| » isInheritedFromBaseType | boolean¦null | false | none | If True, the attribute is part of the base product type and can only have order modified. |
| » order | integer(int32)¦null | false | none | Used to order the display of the attributes within a section |
| » isRequiredByAdmin | boolean¦null | false | none | If True, the admin must include this attribute in products of this productType |
| » isHiddenProperty | boolean¦null | false | none | If True, the property is hidden in the storefront. This field only applies to properties. |
| » isAdminOnlyProperty | boolean¦null | false | none | If true, this property is not available on the storefront. If false, this property will be available on storefront. The IsHiddenProperty hides the property from the customer, but is still available from the API. |
| » isProductDetailsOnlyProperty | boolean¦null | false | none | If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...) |
| » isMultiValueProperty | boolean¦null | false | none | If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties. |
| » displayInfo | AttributeInProductTypeDisplayInfo | false | none | none |
| »» displayIntention | string¦null | false | none | Defines the intended display of this Attribute in the storeFront (ex. DropDown, ImagePicker, RadioButtons....) |
| » vocabularyValues | [AttributeVocabularyValueInProductType]¦null | false | none | The collection of vocabulary values included in this product type. |
| »» value | object¦null | false | none | The actual value of the attribute vocabulary. This must be an existing value defined in the attribute vocabulary |
| »» order | integer(int32)¦null | false | none | Used to order the display of the attribute values in the storefront.... |
| »» displayInfo | AttributeVocabularyValueDisplayInfo | false | none | none |
| »»» cmsId | string¦null | false | none | Id of the image in the CMS. |
| »»» imageUrl | string¦null | false | none | URL of the image. |
| »»» colorValue | string¦null | false | none | Hex Color value to display in a color picker |
| »» vocabularyValueDetail | AttributeVocabularyValue | false | none | Value of an attribute |
| »»» valueSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence. |
| »»» value | object¦null | false | none | The actual value of the attribute vocabulary. This value must be unique within the vocabulary for a single attribute and match the datatype of the attribute. String data type requires a canonical value here or one will be system generated if null. The actual string content displayed to users should be stored as Content. String values require content to be present. Once this value is set it cannot be changed. |
| »»» mappedGenericValues | [object]¦null | false | none | The actual values of the related generic attribute. This value must match the datatype of the attribute and already exist within the Vocabulary values of the related ValueMappingAttribute. Only supporting string at this time. |
| »»» productName | string¦null | false | none | The ProductName when the Attribute DataType is ProductCode. |
| »»» content | AttributeVocabularyValueLocalizedContent | false | none | Attribute Value Localized Resource |
| »»»» localeCode | string¦null | false | none | Language used for the string attribute value. Currently, only en_US is supported. |
| »»»» stringValue | string¦null | false | none | Localized Value in the language of the locale code |
| »»» localizedContent | [AttributeVocabularyValueLocalizedContent]¦null | false | none | The Content of an attribute value. This content is in multiple locals supported by the master catalog and is only valid for String DataType. |
| »»» displayOrder | integer(int32)¦null | false | none | The order in which the attribute value displays. If you omit a value for this property, Mozu infers the display order from the attribute value's position the list. |
| » attributeDetail | Attribute | false | none | Attribute |
| »» adminName | string¦null | false | none | Name of the product displayed in the admin, This field does not need to be unqiue, but is required. It can include spaces...and is limited to a length of 50. |
| »» namespace | string¦null | false | none | NameSpace, each application creating attributes will have a uniqe namespace to avoid name (Code) collisions. The namespace provided must be a valid registered namespace. If no namespace is specified it is assumed to be the namespace of the Tenant. |
| »» attributeCode | string¦null | false | none | Unique identifier of the Attribute. Must be unique within a namespace and cannot be changed once the attribute is created. This value will be generated and match the attribute sequence if not provided on create. |
| »» attributeFQN | string¦null | false | none | Attribute fully qualified name, Read only value that combines namespace and attribute code as NameSpace~AttributeCode |
| »» isValueMappingAttribute | boolean¦null | false | none | Specifies if this attribute can can be used to generalize values of another attribute |
| »» valueMappingAttributeFQN | string¦null | false | none | Attribute fully qualified name of a corresponding value mapping atribuite |
| »» attributeSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence for each attribute created. |
| »» attributeDataTypeSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence for each attribute,DataType created (this is used to optimize indexed field names in search). |
| »» masterCatalogId | integer(int32)¦null | false | none | Indentifier of the master that this attribute is a member of. System-supplied and read-only. Attributes will be created in the MasterCatalog of the supplied context. |
| »» inputType | string¦null | false | none | The InputType type of the attribute. Must be a valid value for InputType defined in InputTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create |
| »» valueType | string¦null | false | none | The ValueType of the attribute. Must be a valid value for ValueType defined in ValueTypeTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create |
| »» dataType | string¦null | false | none | The DataType of the attribute. Must be a valid value for DataType defined in DataTypeTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create |
| »» isOption | boolean¦null | false | none | Specifies if this attribute can have a usage type of Option in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource. |
| »» isExtra | boolean¦null | false | none | Specifies if this attribute can have a usage type of Extra in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource. |
| »» isProperty | boolean¦null | false | none | Specifies if this attribute can have a usage type of Property in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource. |
| »» attributeMetadata | [AttributeMetadataItem]¦null | false | none | Attribute Metadata. This list can contain opaque data (key value pairs) that can be used as a property bag for UI concerns. |
| »»» key | string¦null | false | none | none |
| »»» value | string¦null | false | none | none |
| »» content | AttributeLocalizedContent | false | none | Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display an attribute in multiple languages yet manage it as a single attribute internally. |
| »»» localeCode | string¦null | false | none | Language used for the attribute name and description. Currently, only en_US is supported. |
| »»» name | string¦null | false | none | Name of the attribute in the language specified by LocaleCode. |
| »»» description | string¦null | false | none | Description of the attribute in the language specified by LocaleCode. |
| »» localizedContent | [AttributeLocalizedContent]¦null | false | none | The Content of an attribute. This content is always in the default language of the MasterCatalog. |
| »» validation | AttributeValidation | false | none | Used to validate attributes. |
| »»» regularExpression | string¦null | false | none | Regular expression to run against the attribute value. This should follow JavaScript/EMCA's Regular Expression syntax. |
| »»» minStringLength | integer(int32)¦null | false | none | For validating strings, minimum length allowed for a string. |
| »»» maxStringLength | integer(int32)¦null | false | none | For validating strings, maximum length allowed for a string. |
| »»» minNumericValue | number(double)¦null | false | none | For validating Number attribute value, minimum number allowed. |
| »»» maxNumericValue | number(double)¦null | false | none | For validating Number attribute value, maximum number allowed. |
| »»» minDateValue | string(date-time)¦null | false | none | For validating a DateTime attribute value, minimum datetime allowed. |
| »»» maxDateValue | string(date-time)¦null | false | none | For validating a DateTime attribute value, maximum datetime allowed. |
| »» vocabularyValues | [AttributeVocabularyValue]¦null | false | none | The list of Values for this attribute. Only available for ValueType:PredefinedVocabulary |
| »» searchSettings | AttributeSearchSettings | false | none | Attribute Search Settings. A container for all of the search and indexing settings of an Attribute |
| »»» searchableInStorefront | boolean | false | none | Indicates whether the attribute value should be searchable on the public storefront. |
| »»» searchableInAdmin | boolean | false | none | Indicates whether the attribute value should be searchable in the merchant catalog admin. |
| »»» searchDisplayValue | boolean | false | none | If true, the system will index the display value of string attributes instead of the canonical value for searching. The canonical value will always be used for filtering. Does not apply for for non-string attributes. |
| »»» allowFilteringAndSortingInStorefront | boolean¦null | false | none | Indicates whether the attribute should be able to be used in filters, facets, and sorting on the public storefront. |
| »»» indexValueWithCase | boolean¦null | false | none | Indicates whether the attribute value is case sensative for filtering and faceting. This applies to Text Admin entered attributes. A null value means it is not case sensative |
| »»» customWeightInStorefrontSearch | boolean¦null | false | none | Indicates whether the attribute is indevidually stored as a tokenized field in search for custom term search weight |
| »» auditInfo | AuditInfo | false | none | none |
| »»» updateDate | string(date-time)¦null | false | none | none |
| »»» createDate | string(date-time)¦null | false | none | none |
| »»» updateBy | string¦null | false | none | none |
| »»» createBy | string¦null | false | none | none |
post_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}_Properties
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties
Add or create property
Body parameter
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
| body | body | AttributeInProductType | false | none |
Example responses
200 Response
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":"string","imageUrl":"string","colorValue":"string"},"vocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeInProductType |
get_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}Properties{attributeFQN}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}
Get property
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
| attributeFQN | path | string | true | none |
Example responses
200 Response
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":"string","imageUrl":"string","colorValue":"string"},"vocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeInProductType |
put_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}Properties{attributeFQN}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}
Update property
Body parameter
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
| attributeFQN | path | string | true | none |
| body | body | AttributeInProductType | false | none |
Example responses
200 Response
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
{"attributeFQN":"string","isInheritedFromBaseType":true,"order":0,"isRequiredByAdmin":true,"isHiddenProperty":true,"isAdminOnlyProperty":true,"isProductDetailsOnlyProperty":true,"isMultiValueProperty":true,"displayInfo":{"displayIntention":"string"},"vocabularyValues":[{"value":{},"order":0,"displayInfo":{"cmsId":"string","imageUrl":"string","colorValue":"string"},"vocabularyValueDetail":{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}}],"attributeDetail":{"adminName":"string","namespace":"string","attributeCode":"string","attributeFQN":"string","isValueMappingAttribute":true,"valueMappingAttributeFQN":"string","attributeSequence":0,"attributeDataTypeSequence":0,"masterCatalogId":0,"inputType":"string","valueType":"string","dataType":"string","isOption":true,"isExtra":true,"isProperty":true,"attributeMetadata":[{"key":"string","value":"string"}],"content":{"localeCode":"string","name":"string","description":"string"},"localizedContent":[{"localeCode":"string","name":"string","description":"string"}],"validation":{"regularExpression":"string","minStringLength":0,"maxStringLength":0,"minNumericValue":0,"maxNumericValue":0,"minDateValue":"2019-08-24T14:15:22Z","maxDateValue":"2019-08-24T14:15:22Z"},"vocabularyValues":[{"valueSequence":0,"value":{},"mappedGenericValues":[{}],"productName":"string","content":{"localeCode":"string","stringValue":"string"},"localizedContent":[{"localeCode":null,"stringValue":null}],"displayOrder":0}],"searchSettings":{"searchableInStorefront":true,"searchableInAdmin":true,"searchDisplayValue":true,"allowFilteringAndSortingInStorefront":true,"indexValueWithCase":true,"customWeightInStorefrontSearch":true},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | AttributeInProductType |
delete_commerce_catalog_admin_attributedefinition_producttypes{productTypeId}Properties{attributeFQN}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Properties/{attributeFQN}
Delete property
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| productTypeId | path | integer(int32) | true | none |
| attributeFQN | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
Publishing
post__commerce_catalog_admin_publishing_publishdrafts
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/publishing/publishdrafts \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/publishing/publishdrafts HTTP/1.1
Content-Type: application/json
const inputBody = '{
"allPending": true,
"productCodes": [
"string"
],
"publishSetCode": "string"
}';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/publishing/publishdrafts',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/publishing/publishdrafts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/publishing/publishdrafts', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/publishing/publishdrafts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/publishing/publishdrafts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/publishing/publishdrafts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/publishing/publishdrafts
Body parameter
{
"allPending": true,
"productCodes": [
"string"
],
"publishSetCode": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PublishingScope | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
post__commerce_catalog_admin_publishing_discarddrafts
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/publishing/discarddrafts \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/publishing/discarddrafts HTTP/1.1
Content-Type: application/json
const inputBody = '{
"allPending": true,
"productCodes": [
"string"
],
"publishSetCode": "string"
}';
const headers = {
'Content-Type':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/publishing/discarddrafts',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/publishing/discarddrafts',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/publishing/discarddrafts', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/publishing/discarddrafts', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/publishing/discarddrafts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/publishing/discarddrafts", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/publishing/discarddrafts
Body parameter
{
"allPending": true,
"productCodes": [
"string"
],
"publishSetCode": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PublishingScope | false | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get__commerce_catalog_admin_publishing_publishsets
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/publishing/publishsets \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/publishing/publishsets HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/publishing/publishsets',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/publishing/publishsets',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/publishing/publishsets', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/publishing/publishsets', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/publishing/publishsets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/publishing/publishsets", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/publishing/publishsets
Retrieves a list of PublishSets including the product counts.
Example responses
200 Response
{
"totalCount": 0,
"items": [
{
"code": "string",
"productCount": 0,
"productCodes": [
"string"
]
}
]
}
{"totalCount":0,"items":[{"code":"string","productCount":0,"productCodes":["string"]}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PublishSetCollection |
post__commerce_catalog_admin_publishing_publishsets
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/publishing/publishsets \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/publishing/publishsets HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"code": "string",
"productCount": 0,
"productCodes": [
"string"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/publishing/publishsets',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/publishing/publishsets',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/publishing/publishsets', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/publishing/publishsets', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/publishing/publishsets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/publishing/publishsets", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/publishing/publishsets
Body parameter
{
"code": "string",
"productCount": 0,
"productCodes": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PublishSet | false | none |
Example responses
200 Response
{
"code": "string",
"productCount": 0,
"productCodes": [
"string"
]
}
{"code":"string","productCount":0,"productCodes":["string"]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PublishSet |
get_commerce_catalog_admin_publishing_publishsets{publishSetCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/publishing/publishsets/{publishSetCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/publishing/publishsets/{publishSetCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/publishing/publishsets/{publishSetCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/publishing/publishsets/{publishSetCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/publishing/publishsets/{publishSetCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/publishing/publishsets/{publishSetCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/publishing/publishsets/{publishSetCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/publishing/publishsets/{publishSetCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/publishing/publishsets/{publishSetCode}
Retrieves the details of a single PublishSet.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| publishSetCode | path | string | true | none |
Example responses
200 Response
{
"code": "string",
"productCount": 0,
"productCodes": [
"string"
]
}
{"code":"string","productCount":0,"productCodes":["string"]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | PublishSet |
delete_commerce_catalog_admin_publishing_publishsets{publishSetCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/publishing/publishsets/{publishSetCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/publishing/publishsets/{publishSetCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/publishing/publishsets/{publishSetCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/publishing/publishsets/{publishSetCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/publishing/publishsets/{publishSetCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/publishing/publishsets/{publishSetCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/publishing/publishsets/{publishSetCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/publishing/publishsets/{publishSetCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/publishing/publishsets/{publishSetCode}
Removes all details about a PublishSet from the product service. If the discardDrafts param is true, it also deletes the product drafts.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| publishSetCode | path | string | true | The code of the PublishSet to delete |
| discardDrafts | query | boolean | false | Whether to also discard the drafts for this publish set. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
Search
get_commerce_catalog_admin_search_synonym-definitions{localeCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/search/synonym-definitions/{localeCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/search/synonym-definitions/{localeCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/synonym-definitions/{localeCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/search/synonym-definitions/{localeCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/search/synonym-definitions/{localeCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/search/synonym-definitions/{localeCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/synonym-definitions/{localeCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/search/synonym-definitions/{localeCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/search/synonym-definitions/{localeCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| localeCode | path | string | true | none |
Example responses
200 Response
{
"tenantId": 0,
"siteId": 0,
"localeCode": "string",
"synonymDefinitions": [
{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}
]
}
{"tenantId":0,"siteId":0,"localeCode":"string","synonymDefinitions":[{"synonymId":0,"key":"string","synonyms":["string"]}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SynonymDefinitionCollection |
post_commerce_catalog_admin_search_synonym-definitions{localeCode}
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/search/synonym-definitions/{localeCode} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/search/synonym-definitions/{localeCode} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"tenantId": 0,
"siteId": 0,
"localeCode": "string",
"synonymDefinitions": [
{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/synonym-definitions/{localeCode}',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/search/synonym-definitions/{localeCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/search/synonym-definitions/{localeCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/search/synonym-definitions/{localeCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/synonym-definitions/{localeCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/search/synonym-definitions/{localeCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/search/synonym-definitions/{localeCode}
Body parameter
{
"tenantId": 0,
"siteId": 0,
"localeCode": "string",
"synonymDefinitions": [
{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| localeCode | path | string | true | none |
| body | body | SynonymDefinitionCollection | false | none |
Example responses
200 Response
{
"tenantId": 0,
"siteId": 0,
"localeCode": "string",
"synonymDefinitions": [
{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}
]
}
{"tenantId":0,"siteId":0,"localeCode":"string","synonymDefinitions":[{"synonymId":0,"key":"string","synonyms":["string"]}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SynonymDefinitionCollection |
get_commerce_catalog_admin_search_master-catalog-synonym-definitions{languageCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/search/master-catalog-synonym-definitions/{languageCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/search/master-catalog-synonym-definitions/{languageCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/master-catalog-synonym-definitions/{languageCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/search/master-catalog-synonym-definitions/{languageCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/search/master-catalog-synonym-definitions/{languageCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/search/master-catalog-synonym-definitions/{languageCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/master-catalog-synonym-definitions/{languageCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/search/master-catalog-synonym-definitions/{languageCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/search/master-catalog-synonym-definitions/{languageCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| languageCode | path | string | true | none |
Example responses
200 Response
{
"tenantId": 0,
"siteId": 0,
"localeCode": "string",
"synonymDefinitions": [
{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}
]
}
{"tenantId":0,"siteId":0,"localeCode":"string","synonymDefinitions":[{"synonymId":0,"key":"string","synonyms":["string"]}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SynonymDefinitionCollection |
get__commerce_catalog_admin_search_synonyms
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/search/synonyms \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/search/synonyms HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/synonyms',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/search/synonyms',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/search/synonyms', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/search/synonyms', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/synonyms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/search/synonyms", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/search/synonyms
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| startIndex | query | integer(int32) | false | none |
| pageSize | query | integer(int32) | false | none |
| sortBy | query | string | false | none |
| filter | query | string | false | none |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"synonymId":0,"key":"string","synonyms":["string"]}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SynonymDefinitionPagedCollection |
post__commerce_catalog_admin_search_synonyms
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/search/synonyms \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/search/synonyms HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/synonyms',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/search/synonyms',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/search/synonyms', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/search/synonyms', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/synonyms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/search/synonyms", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/search/synonyms
Body parameter
{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | SynonymDefinition | false | none |
Example responses
200 Response
{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}
{"synonymId":0,"key":"string","synonyms":["string"]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SynonymDefinition |
get_commerce_catalog_admin_search_synonyms{synonymId}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/search/synonyms/{synonymId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/search/synonyms/{synonymId} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/synonyms/{synonymId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/search/synonyms/{synonymId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/search/synonyms/{synonymId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/search/synonyms/{synonymId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/synonyms/{synonymId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/search/synonyms/{synonymId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/search/synonyms/{synonymId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| synonymId | path | integer(int32) | true | none |
Example responses
200 Response
{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}
{"synonymId":0,"key":"string","synonyms":["string"]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SynonymDefinition |
put_commerce_catalog_admin_search_synonyms{synonymId}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/search/synonyms/{synonymId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/search/synonyms/{synonymId} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/synonyms/{synonymId}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/search/synonyms/{synonymId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/search/synonyms/{synonymId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/search/synonyms/{synonymId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/synonyms/{synonymId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/search/synonyms/{synonymId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/search/synonyms/{synonymId}
Body parameter
{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| synonymId | path | integer(int32) | true | none |
| body | body | SynonymDefinition | false | none |
Example responses
200 Response
{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}
{"synonymId":0,"key":"string","synonyms":["string"]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SynonymDefinition |
delete_commerce_catalog_admin_search_synonyms{synonymId}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/search/synonyms/{synonymId} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/search/synonyms/{synonymId} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/synonyms/{synonymId}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/search/synonyms/{synonymId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/search/synonyms/{synonymId}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/search/synonyms/{synonymId}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/synonyms/{synonymId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/search/synonyms/{synonymId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/search/synonyms/{synonymId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| synonymId | path | integer(int32) | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get__commerce_catalog_admin_search_searchtuningrules
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/search/searchtuningrules \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/search/searchtuningrules HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/searchtuningrules',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/search/searchtuningrules',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/search/searchtuningrules', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/search/searchtuningrules', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/searchtuningrules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/search/searchtuningrules", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/search/searchtuningrules
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| startIndex | query | integer(int32) | false | none |
| pageSize | query | integer(int32) | false | none |
| sortBy | query | string | false | none |
| filter | query | string | false | none |
| responseGroups | query | string | false | none |
Example responses
200 Response
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"siteId": 0,
"searchTuningRuleCode": "string",
"searchTuningRuleName": "string",
"searchTuningRuleDescription": "string",
"keywords": [
"string"
],
"filters": [
{
"field": "string",
"value": "string"
}
],
"active": true,
"isDefault": true,
"activeStartDate": "2019-08-24T14:15:22Z",
"activeEndDate": "2019-08-24T14:15:22Z",
"boostedProductCodes": [
"string"
],
"blockedProductCodes": [
"string"
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
{"startIndex":0,"pageSize":0,"pageCount":0,"totalCount":0,"items":[{"siteId":0,"searchTuningRuleCode":"string","searchTuningRuleName":"string","searchTuningRuleDescription":"string","keywords":["string"],"filters":[{"field":"string","value":"string"}],"active":true,"isDefault":true,"activeStartDate":"2019-08-24T14:15:22Z","activeEndDate":"2019-08-24T14:15:22Z","boostedProductCodes":["string"],"blockedProductCodes":["string"],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SearchTuningRuleCollection |
post__commerce_catalog_admin_search_searchtuningrules
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/search/searchtuningrules \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/search/searchtuningrules HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"siteId": 0,
"searchTuningRuleCode": "string",
"searchTuningRuleName": "string",
"searchTuningRuleDescription": "string",
"keywords": [
"string"
],
"filters": [
{
"field": "string",
"value": "string"
}
],
"active": true,
"isDefault": true,
"activeStartDate": "2019-08-24T14:15:22Z",
"activeEndDate": "2019-08-24T14:15:22Z",
"boostedProductCodes": [
"string"
],
"blockedProductCodes": [
"string"
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/searchtuningrules',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/search/searchtuningrules',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/search/searchtuningrules', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/search/searchtuningrules', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/searchtuningrules");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/search/searchtuningrules", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/search/searchtuningrules
Body parameter
{
"siteId": 0,
"searchTuningRuleCode": "string",
"searchTuningRuleName": "string",
"searchTuningRuleDescription": "string",
"keywords": [
"string"
],
"filters": [
{
"field": "string",
"value": "string"
}
],
"active": true,
"isDefault": true,
"activeStartDate": "2019-08-24T14:15:22Z",
"activeEndDate": "2019-08-24T14:15:22Z",
"boostedProductCodes": [
"string"
],
"blockedProductCodes": [
"string"
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | SearchTuningRule | false | none |
Example responses
200 Response
{
"siteId": 0,
"searchTuningRuleCode": "string",
"searchTuningRuleName": "string",
"searchTuningRuleDescription": "string",
"keywords": [
"string"
],
"filters": [
{
"field": "string",
"value": "string"
}
],
"active": true,
"isDefault": true,
"activeStartDate": "2019-08-24T14:15:22Z",
"activeEndDate": "2019-08-24T14:15:22Z",
"boostedProductCodes": [
"string"
],
"blockedProductCodes": [
"string"
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"siteId":0,"searchTuningRuleCode":"string","searchTuningRuleName":"string","searchTuningRuleDescription":"string","keywords":["string"],"filters":[{"field":"string","value":"string"}],"active":true,"isDefault":true,"activeStartDate":"2019-08-24T14:15:22Z","activeEndDate":"2019-08-24T14:15:22Z","boostedProductCodes":["string"],"blockedProductCodes":["string"],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SearchTuningRule |
get_commerce_catalog_admin_search_searchtuningrules{searchTuningRuleCode}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| searchTuningRuleCode | path | string | true | none |
Example responses
200 Response
{
"siteId": 0,
"searchTuningRuleCode": "string",
"searchTuningRuleName": "string",
"searchTuningRuleDescription": "string",
"keywords": [
"string"
],
"filters": [
{
"field": "string",
"value": "string"
}
],
"active": true,
"isDefault": true,
"activeStartDate": "2019-08-24T14:15:22Z",
"activeEndDate": "2019-08-24T14:15:22Z",
"boostedProductCodes": [
"string"
],
"blockedProductCodes": [
"string"
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"siteId":0,"searchTuningRuleCode":"string","searchTuningRuleName":"string","searchTuningRuleDescription":"string","keywords":["string"],"filters":[{"field":"string","value":"string"}],"active":true,"isDefault":true,"activeStartDate":"2019-08-24T14:15:22Z","activeEndDate":"2019-08-24T14:15:22Z","boostedProductCodes":["string"],"blockedProductCodes":["string"],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SearchTuningRule |
put_commerce_catalog_admin_search_searchtuningrules{searchTuningRuleCode}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"siteId": 0,
"searchTuningRuleCode": "string",
"searchTuningRuleName": "string",
"searchTuningRuleDescription": "string",
"keywords": [
"string"
],
"filters": [
{
"field": "string",
"value": "string"
}
],
"active": true,
"isDefault": true,
"activeStartDate": "2019-08-24T14:15:22Z",
"activeEndDate": "2019-08-24T14:15:22Z",
"boostedProductCodes": [
"string"
],
"blockedProductCodes": [
"string"
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}
Body parameter
{
"siteId": 0,
"searchTuningRuleCode": "string",
"searchTuningRuleName": "string",
"searchTuningRuleDescription": "string",
"keywords": [
"string"
],
"filters": [
{
"field": "string",
"value": "string"
}
],
"active": true,
"isDefault": true,
"activeStartDate": "2019-08-24T14:15:22Z",
"activeEndDate": "2019-08-24T14:15:22Z",
"boostedProductCodes": [
"string"
],
"blockedProductCodes": [
"string"
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| searchTuningRuleCode | path | string | true | none |
| body | body | SearchTuningRule | false | none |
Example responses
200 Response
{
"siteId": 0,
"searchTuningRuleCode": "string",
"searchTuningRuleName": "string",
"searchTuningRuleDescription": "string",
"keywords": [
"string"
],
"filters": [
{
"field": "string",
"value": "string"
}
],
"active": true,
"isDefault": true,
"activeStartDate": "2019-08-24T14:15:22Z",
"activeEndDate": "2019-08-24T14:15:22Z",
"boostedProductCodes": [
"string"
],
"blockedProductCodes": [
"string"
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"siteId":0,"searchTuningRuleCode":"string","searchTuningRuleName":"string","searchTuningRuleDescription":"string","keywords":["string"],"filters":[{"field":"string","value":"string"}],"active":true,"isDefault":true,"activeStartDate":"2019-08-24T14:15:22Z","activeEndDate":"2019-08-24T14:15:22Z","boostedProductCodes":["string"],"blockedProductCodes":["string"],"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SearchTuningRule |
delete_commerce_catalog_admin_search_searchtuningrules{searchTuningRuleCode}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode} \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode} HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| searchTuningRuleCode | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get__commerce_catalog_admin_search_searchtuningrulesortfields
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/search/searchtuningrulesortfields \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/search/searchtuningrulesortfields HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/searchtuningrulesortfields',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/search/searchtuningrulesortfields',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/search/searchtuningrulesortfields', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/search/searchtuningrulesortfields', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/searchtuningrulesortfields");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/search/searchtuningrulesortfields", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/search/searchtuningrulesortfields
Example responses
200 Response
{
"sortFields": [
"string"
],
"inclusionExclusionType": "string"
}
{"sortFields":["string"],"inclusionExclusionType":"string"}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SearchTuningRuleSortFields |
post__commerce_catalog_admin_search_searchtuningrulesortfields
Code samples
# You can also use wget
curl -X POST /commerce/catalog/admin/search/searchtuningrulesortfields \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
POST /commerce/catalog/admin/search/searchtuningrulesortfields HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"sortFields": [
"string"
],
"inclusionExclusionType": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/searchtuningrulesortfields',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post '/commerce/catalog/admin/search/searchtuningrulesortfields',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('/commerce/catalog/admin/search/searchtuningrulesortfields', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('POST','/commerce/catalog/admin/search/searchtuningrulesortfields', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/searchtuningrulesortfields");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("POST", "/commerce/catalog/admin/search/searchtuningrulesortfields", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
POST /commerce/catalog/admin/search/searchtuningrulesortfields
Body parameter
{
"sortFields": [
"string"
],
"inclusionExclusionType": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | SearchTuningRuleSortFields | false | none |
Example responses
200 Response
{
"sortFields": [
"string"
],
"inclusionExclusionType": "string"
}
{"sortFields":["string"],"inclusionExclusionType":"string"}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SearchTuningRuleSortFields |
get_commerce_catalog_admin_search{name}_categorysuggestsettings
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/search/{name}/categorysuggestsettings \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/search/{name}/categorysuggestsettings HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/{name}/categorysuggestsettings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/search/{name}/categorysuggestsettings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/search/{name}/categorysuggestsettings', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/search/{name}/categorysuggestsettings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/{name}/categorysuggestsettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/search/{name}/categorysuggestsettings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/search/{name}/categorysuggestsettings
Get CategorySuggestSettings for a specific SearchSettings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | none |
Example responses
200 Response
{
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
}
{"fieldWeights":[{"searchFieldName":"string","weight":0}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SuggestSettings |
put_commerce_catalog_admin_search{name}_categorysuggestsettings
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/search/{name}/categorysuggestsettings \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/search/{name}/categorysuggestsettings HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/{name}/categorysuggestsettings',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/search/{name}/categorysuggestsettings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/search/{name}/categorysuggestsettings', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/search/{name}/categorysuggestsettings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/{name}/categorysuggestsettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/search/{name}/categorysuggestsettings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/search/{name}/categorysuggestsettings
Adds or Updates (Upsert) the CategorySuggestSettings for a specific SearchSetting
Body parameter
{
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | none |
| body | body | SuggestSettings | false | none |
Example responses
200 Response
{
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
}
{"fieldWeights":[{"searchFieldName":"string","weight":0}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SuggestSettings |
delete_commerce_catalog_admin_search{name}_categorysuggestsettings
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/search/{name}/categorysuggestsettings \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/search/{name}/categorysuggestsettings HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/{name}/categorysuggestsettings',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/search/{name}/categorysuggestsettings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/search/{name}/categorysuggestsettings', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/search/{name}/categorysuggestsettings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/{name}/categorysuggestsettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/search/{name}/categorysuggestsettings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/search/{name}/categorysuggestsettings
Deletes the CategorySuggestSettings for a specific SearchSetting
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_search{name}_listingsettings
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/search/{name}/listingsettings \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/search/{name}/listingsettings HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/{name}/listingsettings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/search/{name}/listingsettings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/search/{name}/listingsettings', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/search/{name}/listingsettings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/{name}/listingsettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/search/{name}/listingsettings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/search/{name}/listingsettings
Get ListingSettings for a specific SearchSettings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | none |
Example responses
200 Response
{
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
{
"value": null,
"boost": null,
"operator": null
}
]
}
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
}
{"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[{"value":null,"boost":null,"operator":null}]}]},"personalizationExperience":"string","personalizationFactor":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ListingSettings |
put_commerce_catalog_admin_search{name}_listingsettings
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/search/{name}/listingsettings \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/search/{name}/listingsettings HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
{
"value": null,
"boost": null,
"operator": null
}
]
}
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/{name}/listingsettings',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/search/{name}/listingsettings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/search/{name}/listingsettings', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/search/{name}/listingsettings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/{name}/listingsettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/search/{name}/listingsettings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/search/{name}/listingsettings
Adds or Updates (Upsert) the ListingSettings for a specific SearchSetting
Body parameter
{
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
{
"value": null,
"boost": null,
"operator": null
}
]
}
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | none |
| body | body | ListingSettings | false | none |
Example responses
200 Response
{
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
{
"value": null,
"boost": null,
"operator": null
}
]
}
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
}
{"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[{"value":null,"boost":null,"operator":null}]}]},"personalizationExperience":"string","personalizationFactor":0}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ListingSettings |
delete_commerce_catalog_admin_search{name}_listingsettings
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/search/{name}/listingsettings \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/search/{name}/listingsettings HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/{name}/listingsettings',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/search/{name}/listingsettings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/search/{name}/listingsettings', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/search/{name}/listingsettings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/{name}/listingsettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/search/{name}/listingsettings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/search/{name}/listingsettings
Deletes the ListingSettings for a specific SearchSetting
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get_commerce_catalog_admin_search{name}_productsuggestsettings
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/search/{name}/productsuggestsettings \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/search/{name}/productsuggestsettings HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/{name}/productsuggestsettings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/search/{name}/productsuggestsettings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/search/{name}/productsuggestsettings', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/search/{name}/productsuggestsettings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/{name}/productsuggestsettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/search/{name}/productsuggestsettings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/search/{name}/productsuggestsettings
Get ProductSuggestSettings for a specific SearchSettings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | none |
Example responses
200 Response
{
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
}
{"fieldWeights":[{"searchFieldName":"string","weight":0}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SuggestSettings |
put_commerce_catalog_admin_search{name}_productsuggestsettings
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/search/{name}/productsuggestsettings \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/search/{name}/productsuggestsettings HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
{
"value": null,
"boost": null,
"operator": null
}
]
}
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/{name}/productsuggestsettings',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/search/{name}/productsuggestsettings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/search/{name}/productsuggestsettings', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/search/{name}/productsuggestsettings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/{name}/productsuggestsettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/search/{name}/productsuggestsettings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/search/{name}/productsuggestsettings
Adds or Updates (Upsert) the ProductSuggestSettings for a specific SearchSetting
Body parameter
{
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
{
"value": null,
"boost": null,
"operator": null
}
]
}
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | none |
| body | body | ProductSuggestSettings | false | none |
Example responses
200 Response
{
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
{
"value": null,
"boost": null,
"operator": null
}
]
}
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
}
{"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[{"value":null,"boost":null,"operator":null}]}]},"searchChildProductsByDefault":true,"fieldWeights":[{"searchFieldName":"string","weight":0}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | ProductSuggestSettings |
delete_commerce_catalog_admin_search{name}_productsuggestsettings
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/search/{name}/productsuggestsettings \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/search/{name}/productsuggestsettings HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/{name}/productsuggestsettings',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/search/{name}/productsuggestsettings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/search/{name}/productsuggestsettings', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/search/{name}/productsuggestsettings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/{name}/productsuggestsettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/search/{name}/productsuggestsettings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/search/{name}/productsuggestsettings
Deletes the ProductSuggestSettings for a specific SearchSetting
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
get__commerce_catalog_admin_search_settings
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/search/settings \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/search/settings HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/settings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/search/settings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/search/settings', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/search/settings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/settings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/search/settings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/search/settings
Get site search settings
Example responses
200 Response
{
"totalCount": 0,
"items": [
{
"settingsName": "string",
"isDefault": true,
"siteSearchSettings": {
"fieldWeights": [
{
"phraseWeight": null,
"searchFieldName": null,
"weight": null
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
null
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
},
"productSuggestSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
null
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": null,
"weight": null
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"categorySuggestSettings": {
"fieldWeights": [
{
"searchFieldName": null,
"weight": null
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"listingSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
null
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
{"totalCount":0,"items":[{"settingsName":"string","isDefault":true,"siteSearchSettings":{"fieldWeights":[{"phraseWeight":null,"searchFieldName":null,"weight":null}],"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[null]},"minimumMatchPercents":[0],"phraseSlop":0,"personalizationExperience":"string","personalizationFactor":0,"searchChildProductsByDefault":true},"productSuggestSettings":{"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[null]},"searchChildProductsByDefault":true,"fieldWeights":[{"searchFieldName":null,"weight":null}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]},"categorySuggestSettings":{"fieldWeights":[{"searchFieldName":null,"weight":null}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]},"listingSettings":{"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[null]},"personalizationExperience":"string","personalizationFactor":0},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}]}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SearchSettingsCollection |
put__commerce_catalog_admin_search_settings
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/search/settings \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/search/settings HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"settingsName": "string",
"isDefault": true,
"siteSearchSettings": {
"fieldWeights": [
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
},
"productSuggestSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"categorySuggestSettings": {
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"listingSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/settings',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/search/settings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/search/settings', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/search/settings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/settings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/search/settings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/search/settings
Adds or Updates (Upsert) the Search Settings for a specific site
Body parameter
{
"settingsName": "string",
"isDefault": true,
"siteSearchSettings": {
"fieldWeights": [
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
},
"productSuggestSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"categorySuggestSettings": {
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"listingSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| fromSystemDefault | query | boolean | false | none |
| name | query | string | false | none |
| makeDefault | query | boolean | false | none |
| body | body | SearchSettings | false | none |
Example responses
200 Response
{
"settingsName": "string",
"isDefault": true,
"siteSearchSettings": {
"fieldWeights": [
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
},
"productSuggestSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"categorySuggestSettings": {
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"listingSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"settingsName":"string","isDefault":true,"siteSearchSettings":{"fieldWeights":[{"phraseWeight":0,"searchFieldName":"string","weight":0}],"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[null]}]},"minimumMatchPercents":[0],"phraseSlop":0,"personalizationExperience":"string","personalizationFactor":0,"searchChildProductsByDefault":true},"productSuggestSettings":{"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[null]}]},"searchChildProductsByDefault":true,"fieldWeights":[{"searchFieldName":"string","weight":0}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]},"categorySuggestSettings":{"fieldWeights":[{"searchFieldName":"string","weight":0}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]},"listingSettings":{"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[null]}]},"personalizationExperience":"string","personalizationFactor":0},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SearchSettings |
get_commerce_catalog_admin_search_settings{name}
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/search/settings/{name} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/search/settings/{name} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/settings/{name}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/search/settings/{name}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/search/settings/{name}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/search/settings/{name}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/settings/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/search/settings/{name}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/search/settings/{name}
Get site search settings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | none |
Example responses
200 Response
{
"settingsName": "string",
"isDefault": true,
"siteSearchSettings": {
"fieldWeights": [
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
},
"productSuggestSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"categorySuggestSettings": {
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"listingSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"settingsName":"string","isDefault":true,"siteSearchSettings":{"fieldWeights":[{"phraseWeight":0,"searchFieldName":"string","weight":0}],"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[null]}]},"minimumMatchPercents":[0],"phraseSlop":0,"personalizationExperience":"string","personalizationFactor":0,"searchChildProductsByDefault":true},"productSuggestSettings":{"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[null]}]},"searchChildProductsByDefault":true,"fieldWeights":[{"searchFieldName":"string","weight":0}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]},"categorySuggestSettings":{"fieldWeights":[{"searchFieldName":"string","weight":0}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]},"listingSettings":{"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[null]}]},"personalizationExperience":"string","personalizationFactor":0},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SearchSettings |
put_commerce_catalog_admin_search_settings{name}
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/search/settings/{name} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/search/settings/{name} HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"settingsName": "string",
"isDefault": true,
"siteSearchSettings": {
"fieldWeights": [
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
},
"productSuggestSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"categorySuggestSettings": {
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"listingSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/settings/{name}',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/search/settings/{name}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/search/settings/{name}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/search/settings/{name}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/settings/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/search/settings/{name}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/search/settings/{name}
Adds or Updates (Upsert) the Search Settings for a specific site
Body parameter
{
"settingsName": "string",
"isDefault": true,
"siteSearchSettings": {
"fieldWeights": [
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
},
"productSuggestSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"categorySuggestSettings": {
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"listingSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | none |
| body | body | SearchSettings | false | none |
Example responses
200 Response
{
"settingsName": "string",
"isDefault": true,
"siteSearchSettings": {
"fieldWeights": [
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
},
"productSuggestSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"categorySuggestSettings": {
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"listingSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"settingsName":"string","isDefault":true,"siteSearchSettings":{"fieldWeights":[{"phraseWeight":0,"searchFieldName":"string","weight":0}],"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[null]}]},"minimumMatchPercents":[0],"phraseSlop":0,"personalizationExperience":"string","personalizationFactor":0,"searchChildProductsByDefault":true},"productSuggestSettings":{"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[null]}]},"searchChildProductsByDefault":true,"fieldWeights":[{"searchFieldName":"string","weight":0}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]},"categorySuggestSettings":{"fieldWeights":[{"searchFieldName":"string","weight":0}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]},"listingSettings":{"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[null]}]},"personalizationExperience":"string","personalizationFactor":0},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SearchSettings |
delete_commerce_catalog_admin_search_settings{name}
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/search/settings/{name} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/search/settings/{name} HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/settings/{name}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/search/settings/{name}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/search/settings/{name}', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/search/settings/{name}', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/settings/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/search/settings/{name}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/search/settings/{name}
Adds or Updates (Upsert) the Search Settings for a specific site
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | none |
Example responses
200 Response
{
"settingsName": "string",
"isDefault": true,
"siteSearchSettings": {
"fieldWeights": [
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
},
"productSuggestSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"categorySuggestSettings": {
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"listingSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"settingsName":"string","isDefault":true,"siteSearchSettings":{"fieldWeights":[{"phraseWeight":0,"searchFieldName":"string","weight":0}],"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[null]}]},"minimumMatchPercents":[0],"phraseSlop":0,"personalizationExperience":"string","personalizationFactor":0,"searchChildProductsByDefault":true},"productSuggestSettings":{"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[null]}]},"searchChildProductsByDefault":true,"fieldWeights":[{"searchFieldName":"string","weight":0}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]},"categorySuggestSettings":{"fieldWeights":[{"searchFieldName":"string","weight":0}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]},"listingSettings":{"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[null]}]},"personalizationExperience":"string","personalizationFactor":0},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SearchSettings |
get__commerce_catalog_admin_search_settings_systemdefault
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/search/settings/systemdefault \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/search/settings/systemdefault HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/settings/systemdefault',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/search/settings/systemdefault',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/search/settings/systemdefault', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/search/settings/systemdefault', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/settings/systemdefault");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/search/settings/systemdefault", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/search/settings/systemdefault
Get the System Default search settings
Example responses
200 Response
{
"settingsName": "string",
"isDefault": true,
"siteSearchSettings": {
"fieldWeights": [
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
},
"productSuggestSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"categorySuggestSettings": {
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"listingSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
{"settingsName":"string","isDefault":true,"siteSearchSettings":{"fieldWeights":[{"phraseWeight":0,"searchFieldName":"string","weight":0}],"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[null]}]},"minimumMatchPercents":[0],"phraseSlop":0,"personalizationExperience":"string","personalizationFactor":0,"searchChildProductsByDefault":true},"productSuggestSettings":{"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[null]}]},"searchChildProductsByDefault":true,"fieldWeights":[{"searchFieldName":"string","weight":0}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]},"categorySuggestSettings":{"fieldWeights":[{"searchFieldName":"string","weight":0}],"personalizationExperience":"string","personalizationFactor":0,"returnFields":["string"]},"listingSettings":{"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[null]}]},"personalizationExperience":"string","personalizationFactor":0},"auditInfo":{"updateDate":"2019-08-24T14:15:22Z","createDate":"2019-08-24T14:15:22Z","updateBy":"string","createBy":"string"}}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SearchSettings |
get_commerce_catalog_admin_search{name}_sitesearchsettings
Code samples
# You can also use wget
curl -X GET /commerce/catalog/admin/search/{name}/sitesearchsettings \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
GET /commerce/catalog/admin/search/{name}/sitesearchsettings HTTP/1.1
Accept: application/json
const headers = {
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/{name}/sitesearchsettings',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.get '/commerce/catalog/admin/search/{name}/sitesearchsettings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('/commerce/catalog/admin/search/{name}/sitesearchsettings', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('GET','/commerce/catalog/admin/search/{name}/sitesearchsettings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/{name}/sitesearchsettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "/commerce/catalog/admin/search/{name}/sitesearchsettings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
GET /commerce/catalog/admin/search/{name}/sitesearchsettings
Get SiteSearchSettings for a specific SearchSettings
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | none |
Example responses
200 Response
{
"fieldWeights": [
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
{
"value": null,
"boost": null,
"operator": null
}
]
}
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
}
{"fieldWeights":[{"phraseWeight":0,"searchFieldName":"string","weight":0}],"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[{"value":null,"boost":null,"operator":null}]}]},"minimumMatchPercents":[0],"phraseSlop":0,"personalizationExperience":"string","personalizationFactor":0,"searchChildProductsByDefault":true}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SiteSearchSettings |
put_commerce_catalog_admin_search{name}_sitesearchsettings
Code samples
# You can also use wget
curl -X PUT /commerce/catalog/admin/search/{name}/sitesearchsettings \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
PUT /commerce/catalog/admin/search/{name}/sitesearchsettings HTTP/1.1
Content-Type: application/json
Accept: application/json
const inputBody = '{
"fieldWeights": [
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
{
"value": null,
"boost": null,
"operator": null
}
]
}
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/{name}/sitesearchsettings',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put '/commerce/catalog/admin/search/{name}/sitesearchsettings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.put('/commerce/catalog/admin/search/{name}/sitesearchsettings', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('PUT','/commerce/catalog/admin/search/{name}/sitesearchsettings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/{name}/sitesearchsettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Content-Type": []string{"application/json"},
"Accept": []string{"application/json"},
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("PUT", "/commerce/catalog/admin/search/{name}/sitesearchsettings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
PUT /commerce/catalog/admin/search/{name}/sitesearchsettings
Adds or Updates (Upsert) the SiteSearchSettings for a specific SearchSetting
Body parameter
{
"fieldWeights": [
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
{
"value": null,
"boost": null,
"operator": null
}
]
}
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | none |
| body | body | SiteSearchSettings | false | none |
Example responses
200 Response
{
"fieldWeights": [
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
{
"value": null,
"boost": null,
"operator": null
}
]
}
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
}
{"fieldWeights":[{"phraseWeight":0,"searchFieldName":"string","weight":0}],"customBoosts":["string"],"fieldValueBoost":{"boostType":"string","fields":[{"fieldName":"string","valueExpressions":[{"value":null,"boost":null,"operator":null}]}]},"minimumMatchPercents":[0],"phraseSlop":0,"personalizationExperience":"string","personalizationFactor":0,"searchChildProductsByDefault":true}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | SiteSearchSettings |
delete_commerce_catalog_admin_search{name}_sitesearchsettings
Code samples
# You can also use wget
curl -X DELETE /commerce/catalog/admin/search/{name}/sitesearchsettings \
-H 'Authorization: Bearer {access-token}' \
-H 'Authorization: Bearer {access-token}'
DELETE /commerce/catalog/admin/search/{name}/sitesearchsettings HTTP/1.1
const headers = {
'Authorization':'Bearer {access-token}',
'Authorization':'Bearer {access-token}'
};
fetch('/commerce/catalog/admin/search/{name}/sitesearchsettings',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
require 'rest-client'
require 'json'
headers = {
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete '/commerce/catalog/admin/search/{name}/sitesearchsettings',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Authorization': 'Bearer {access-token}',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('/commerce/catalog/admin/search/{name}/sitesearchsettings', headers = headers)
print(r.json())
<?php
require 'vendor/autoload.php';
$headers = array(
'Authorization' => 'Bearer {access-token}',
'Authorization' => 'Bearer {access-token}',
);
$client = new \GuzzleHttp\Client();
// Define array of request body.
$request_body = array();
try {
$response = $client->request('DELETE','/commerce/catalog/admin/search/{name}/sitesearchsettings', array(
'headers' => $headers,
'json' => $request_body,
)
);
print_r($response->getBody()->getContents());
}
catch (\GuzzleHttp\Exception\BadResponseException $e) {
// handle exception or api errors.
print_r($e->getMessage());
}
// ...
URL obj = new URL("/commerce/catalog/admin/search/{name}/sitesearchsettings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Authorization": []string{"Bearer {access-token}"},
"Authorization": []string{"Bearer {access-token}"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("DELETE", "/commerce/catalog/admin/search/{name}/sitesearchsettings", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
DELETE /commerce/catalog/admin/search/{name}/sitesearchsettings
Deletes the SiteSearchSettings for a specific SearchSetting
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | path | string | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Success | None |
Schemas
AttributeMetadataItem
{
"key": "string",
"value": "string"
}
Attribute Metadata Item. It can be utilized for storing abitrary key/value pairs of data related to an attribute.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| key | string¦null | false | none | none |
| value | string¦null | false | none | none |
AttributeLocalizedContent
{
"localeCode": "string",
"name": "string",
"description": "string"
}
Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display an attribute in multiple languages yet manage it as a single attribute internally.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| localeCode | string¦null | false | none | Language used for the attribute name and description. Currently, only en_US is supported. |
| name | string¦null | false | none | Name of the attribute in the language specified by LocaleCode. |
| description | string¦null | false | none | Description of the attribute in the language specified by LocaleCode. |
AttributeValidation
{
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
}
Used to validate attributes.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| regularExpression | string¦null | false | none | Regular expression to run against the attribute value. This should follow JavaScript/EMCA's Regular Expression syntax. |
| minStringLength | integer(int32)¦null | false | none | For validating strings, minimum length allowed for a string. |
| maxStringLength | integer(int32)¦null | false | none | For validating strings, maximum length allowed for a string. |
| minNumericValue | number(double)¦null | false | none | For validating Number attribute value, minimum number allowed. |
| maxNumericValue | number(double)¦null | false | none | For validating Number attribute value, maximum number allowed. |
| minDateValue | string(date-time)¦null | false | none | For validating a DateTime attribute value, minimum datetime allowed. |
| maxDateValue | string(date-time)¦null | false | none | For validating a DateTime attribute value, maximum datetime allowed. |
AttributeVocabularyValueLocalizedContent
{
"localeCode": "string",
"stringValue": "string"
}
Attribute Value Localized Resource
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| localeCode | string¦null | false | none | Language used for the string attribute value. Currently, only en_US is supported. |
| stringValue | string¦null | false | none | Localized Value in the language of the locale code |
AttributeVocabularyValue
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
Value of an attribute
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| valueSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence. |
| value | object¦null | false | none | The actual value of the attribute vocabulary. This value must be unique within the vocabulary for a single attribute and match the datatype of the attribute. String data type requires a canonical value here or one will be system generated if null. The actual string content displayed to users should be stored as Content. String values require content to be present. Once this value is set it cannot be changed. |
| mappedGenericValues | [object]¦null | false | none | The actual values of the related generic attribute. This value must match the datatype of the attribute and already exist within the Vocabulary values of the related ValueMappingAttribute. Only supporting string at this time. |
| productName | string¦null | false | none | The ProductName when the Attribute DataType is ProductCode. |
| content | AttributeVocabularyValueLocalizedContent | false | none | Attribute Value Localized Resource |
| localizedContent | [AttributeVocabularyValueLocalizedContent]¦null | false | none | The Content of an attribute value. This content is in multiple locals supported by the master catalog and is only valid for String DataType. |
| displayOrder | integer(int32)¦null | false | none | The order in which the attribute value displays. If you omit a value for this property, Mozu infers the display order from the attribute value's position the list. |
AttributeSearchSettings
{
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
}
Attribute Search Settings. A container for all of the search and indexing settings of an Attribute
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| searchableInStorefront | boolean | false | none | Indicates whether the attribute value should be searchable on the public storefront. |
| searchableInAdmin | boolean | false | none | Indicates whether the attribute value should be searchable in the merchant catalog admin. |
| searchDisplayValue | boolean | false | none | If true, the system will index the display value of string attributes instead of the canonical value for searching. The canonical value will always be used for filtering. Does not apply for for non-string attributes. |
| allowFilteringAndSortingInStorefront | boolean¦null | false | none | Indicates whether the attribute should be able to be used in filters, facets, and sorting on the public storefront. |
| indexValueWithCase | boolean¦null | false | none | Indicates whether the attribute value is case sensative for filtering and faceting. This applies to Text Admin entered attributes. A null value means it is not case sensative |
| customWeightInStorefrontSearch | boolean¦null | false | none | Indicates whether the attribute is indevidually stored as a tokenized field in search for custom term search weight |
AuditInfo
{
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| updateDate | string(date-time)¦null | false | none | none |
| createDate | string(date-time)¦null | false | none | none |
| updateBy | string¦null | false | none | none |
| createBy | string¦null | false | none | none |
Attribute
{
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Attribute
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| adminName | string¦null | false | none | Name of the product displayed in the admin, This field does not need to be unqiue, but is required. It can include spaces...and is limited to a length of 50. |
| namespace | string¦null | false | none | NameSpace, each application creating attributes will have a uniqe namespace to avoid name (Code) collisions. The namespace provided must be a valid registered namespace. If no namespace is specified it is assumed to be the namespace of the Tenant. |
| attributeCode | string¦null | false | none | Unique identifier of the Attribute. Must be unique within a namespace and cannot be changed once the attribute is created. This value will be generated and match the attribute sequence if not provided on create. |
| attributeFQN | string¦null | false | none | Attribute fully qualified name, Read only value that combines namespace and attribute code as NameSpace~AttributeCode |
| isValueMappingAttribute | boolean¦null | false | none | Specifies if this attribute can can be used to generalize values of another attribute |
| valueMappingAttributeFQN | string¦null | false | none | Attribute fully qualified name of a corresponding value mapping atribuite |
| attributeSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence for each attribute created. |
| attributeDataTypeSequence | integer(int32)¦null | false | none | Read only System generated monotonically increasing unique sequence for each attribute,DataType created (this is used to optimize indexed field names in search). |
| masterCatalogId | integer(int32)¦null | false | none | Indentifier of the master that this attribute is a member of. System-supplied and read-only. Attributes will be created in the MasterCatalog of the supplied context. |
| inputType | string¦null | false | none | The InputType type of the attribute. Must be a valid value for InputType defined in InputTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create |
| valueType | string¦null | false | none | The ValueType of the attribute. Must be a valid value for ValueType defined in ValueTypeTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create |
| dataType | string¦null | false | none | The DataType of the attribute. Must be a valid value for DataType defined in DataTypeTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create |
| isOption | boolean¦null | false | none | Specifies if this attribute can have a usage type of Option in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource. |
| isExtra | boolean¦null | false | none | Specifies if this attribute can have a usage type of Extra in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource. |
| isProperty | boolean¦null | false | none | Specifies if this attribute can have a usage type of Property in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource. |
| attributeMetadata | [AttributeMetadataItem]¦null | false | none | Attribute Metadata. This list can contain opaque data (key value pairs) that can be used as a property bag for UI concerns. |
| content | AttributeLocalizedContent | false | none | Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display an attribute in multiple languages yet manage it as a single attribute internally. |
| localizedContent | [AttributeLocalizedContent]¦null | false | none | The Content of an attribute. This content is always in the default language of the MasterCatalog. |
| validation | AttributeValidation | false | none | Used to validate attributes. |
| vocabularyValues | [AttributeVocabularyValue]¦null | false | none | The list of Values for this attribute. Only available for ValueType:PredefinedVocabulary |
| searchSettings | AttributeSearchSettings | false | none | Attribute Search Settings. A container for all of the search and indexing settings of an Attribute |
| auditInfo | AuditInfo | false | none | none |
AttributeCollection
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
Collection of attributes.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| pageCount | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [Attribute]¦null | false | none | [Attribute] |
AttributeTypeRule
{
"attributeInputType": "string",
"attributeDataType": "string",
"attributeValueType": "string",
"attributeUsageType": "string"
}
Attribute Value Localized Resource
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| attributeInputType | string¦null | false | none | AttributeInputType identifier |
| attributeDataType | string¦null | false | none | AttributeDataType identifier |
| attributeValueType | string¦null | false | none | AttributeValueType identifier |
| attributeUsageType | string¦null | false | none | AttributeUsageType identifier |
AttributeTypeRuleCollection
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"attributeInputType": "string",
"attributeDataType": "string",
"attributeValueType": "string",
"attributeUsageType": "string"
}
]
}
A collection of AttributeType rules
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| pageCount | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [AttributeTypeRule]¦null | false | none | [Attribute Value Localized Resource] |
CategoryLocalizedImage
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0
}
Contains the image label and alternate text for a category image or video in the language specified by LocalCode.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32)¦null | false | none | Unique identifier of the image. System-supplied and read-only. |
| localeCode | string¦null | false | none | Language used for the image content. |
| imageLabel | string¦null | false | none | Image title that appears on the storefront. |
| altText | string¦null | false | none | Descriptive text associated with the image or video that appears on the storefront. |
| imageUrl | string¦null | false | none | URL of the image. |
| cmsId | string¦null | false | none | Id of the image in the CMS. |
| videoUrl | string¦null | false | none | URL of a video associated with the category. |
| mediaType | string¦null | false | none | Type of media. Used by the client to determine how to render the image or video or what have you. |
| sequence | integer(int32)¦null | false | none | For categories with multiple images, the order in which this image appears on the storefront. |
CategoryLocalizedContent
{
"localeCode": "string",
"name": "string",
"slug": "string",
"description": "string",
"pageTitle": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"categoryImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0
}
]
}
Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a category in multiple languages yet manage it as a single category internally.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| localeCode | string¦null | false | none | Lanugage used for category content. Currently, only en_US is supported. |
| name | string¦null | false | none | Name of the category. |
| slug | string¦null | false | none | Human-readable identifier that you can give to the category to create friendly URLs. For example, instead of "http: //example.com/products?category=2&id=25," the friendly URL can be "http: //example.com/products/category/2/25." |
| description | string¦null | false | none | Description of the category to display on the storefront. |
| pageTitle | string¦null | false | none | Title that appears at the top of new pages. |
| metaTagTitle | string¦null | false | none | Metadata title. Metadata can be used to manage information internally. Sometimes used for SEO. |
| metaTagDescription | string¦null | false | none | Metadata description. Metadata can be used to manage information internally. Sometimes used for SEO. |
| metaTagKeywords | string¦null | false | none | Metadata keywords. Metadata can be used to manage information internally. Sometimes used for SEO. |
| categoryImages | [CategoryLocalizedImage]¦null | false | none | List of images associated with the category. |
Expression
{
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
{}
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string¦null | false | none | Container or Predicate |
| logicalOperator | string¦null | false | none | And or Or (if Container with More than one Node) |
| nodes | [Expression]¦null | false | none | none |
| left | string¦null | false | none | The field target of a predicate |
| operator | string¦null | false | none | The operator of a predicate |
| right | object¦null | false | none | The literal values of a predicate |
DynamicExpression
{
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": null,
"logicalOperator": null,
"nodes": null,
"left": null,
"operator": null,
"right": null
}
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
}
Category
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| text | string¦null | false | none | none |
| tree | Expression | false | none | none |
Category
{
"id": 0,
"categoryType": "string",
"catalogId": 0,
"parentCategoryId": 0,
"parentCategoryCode": "string",
"parentCategoryName": "string",
"parentIsActive": true,
"categoryCode": "string",
"isActive": true,
"isDisplayed": true,
"sequence": 0,
"content": {
"localeCode": "string",
"name": "string",
"slug": "string",
"description": "string",
"pageTitle": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"categoryImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0
}
]
},
"dynamicExpression": {
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
{
"type": "string",
"logicalOperator": "string",
"nodes": [
null
],
"left": "string",
"operator": "string",
"right": {}
}
],
"left": "string",
"operator": "string",
"right": {}
}
},
"productCount": 0,
"childCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"shouldSlice": true
}
Category
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32)¦null | false | none | Internal unique identifier of the category. System-supplied and read-only. |
| categoryType | string¦null | false | none | The Type of Category Static, Dyanmic, DynamicPreComputed |
| catalogId | integer(int32)¦null | false | none | The CatalogId that the category belongs to. |
| parentCategoryId | integer(int32)¦null | false | none | Unique identifier of the category to which this category belongs. If nil, this is a top-level category. System-supplied and read-only. |
| parentCategoryCode | string¦null | false | none | none |
| parentCategoryName | string¦null | false | none | none |
| parentIsActive | boolean¦null | false | none | none |
| categoryCode | string¦null | false | none | External unique identifier of the category. |
| isActive | boolean¦null | false | none | If false, the category is considered unavailable in runtime (default is true if not specified on create) |
| isDisplayed | boolean¦null | false | none | If true, the category appears to shoppers on the storefront. |
| sequence | integer(int32)¦null | false | none | Order in which categories appear when they are at the same level (siblings). For example, you could change the sequence of categories so that a specific category always appears first. |
| content | CategoryLocalizedContent | false | none | Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a category in multiple languages yet manage it as a single category internally. |
| dynamicExpression | DynamicExpression | false | none | Category |
| productCount | integer(int32)¦null | false | none | Number of products contained in this category. This count includes all products contained in any subcategories of this category. |
| childCount | integer(int32)¦null | false | none | Number of subcategories that belong to this category. These subcategories are at the same level (siblings). |
| auditInfo | AuditInfo | false | none | none |
| shouldSlice | boolean¦null | false | none | If True, search displays sliced view |
CategoryPagedCollection
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"id": 0,
"categoryType": "string",
"catalogId": 0,
"parentCategoryId": 0,
"parentCategoryCode": "string",
"parentCategoryName": "string",
"parentIsActive": true,
"categoryCode": "string",
"isActive": true,
"isDisplayed": true,
"sequence": 0,
"content": {
"localeCode": "string",
"name": "string",
"slug": "string",
"description": "string",
"pageTitle": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"categoryImages": [
{
"id": null,
"localeCode": null,
"imageLabel": null,
"altText": null,
"imageUrl": null,
"cmsId": null,
"videoUrl": null,
"mediaType": null,
"sequence": null
}
]
},
"dynamicExpression": {
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
null
],
"left": "string",
"operator": "string",
"right": {}
}
},
"productCount": 0,
"childCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"shouldSlice": true
}
]
}
Collection of categories where categories are returned in a series of pages.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| pageCount | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [Category]¦null | false | none | [Category] |
CategoryCollection
{
"totalCount": 0,
"items": [
{
"id": 0,
"categoryType": "string",
"catalogId": 0,
"parentCategoryId": 0,
"parentCategoryCode": "string",
"parentCategoryName": "string",
"parentIsActive": true,
"categoryCode": "string",
"isActive": true,
"isDisplayed": true,
"sequence": 0,
"content": {
"localeCode": "string",
"name": "string",
"slug": "string",
"description": "string",
"pageTitle": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"categoryImages": [
{
"id": null,
"localeCode": null,
"imageLabel": null,
"altText": null,
"imageUrl": null,
"cmsId": null,
"videoUrl": null,
"mediaType": null,
"sequence": null
}
]
},
"dynamicExpression": {
"text": "string",
"tree": {
"type": "string",
"logicalOperator": "string",
"nodes": [
null
],
"left": "string",
"operator": "string",
"right": {}
}
},
"productCount": 0,
"childCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"shouldSlice": true
}
]
}
Collection of categories returned as a whole. A collection is not paged.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| totalCount | integer(int32) | false | none | none |
| items | [Category]¦null | false | none | [Category] |
CoreField
{
"fieldName": "string",
"label": "string",
"entityTpe": "string",
"dataType": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fieldName | string¦null | false | none | none |
| label | string¦null | false | none | none |
| entityTpe | string¦null | false | none | none |
| dataType | string¦null | false | none | none |
CoreFieldCollection
{
"totalCount": 0,
"items": [
{
"fieldName": "string",
"label": "string",
"entityTpe": "string",
"dataType": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| totalCount | integer(int32) | false | none | none |
| items | [CoreField]¦null | false | none | none |
CouponSet
{
"id": 0,
"couponSetCode": "string",
"name": "string",
"couponCodeType": "string",
"status": "string",
"canBeDeleted": true,
"maxRedemptionsPerUser": 0,
"maxRedemptionsPerCouponCode": 0,
"endDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"setSize": 0,
"couponCodeCount": 0,
"redemptionCount": 0,
"assignedDiscountCount": 0
}
Represents a claimable item that allows a user to use one or more discounts.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32)¦null | false | none | Internal unique identifier of the couponset. System-supplied and read-only. |
| couponSetCode | string¦null | false | none | Unique tenant supplied identifier. Used as the prefix for generated sets. Required System generated if left null. |
| name | string | true | none | CouponSet Name |
| couponCodeType | string¦null | false | none | Determines if the coupon is a persisted list of codes (static) or a list based on generated specification (dynamic). |
| status | string¦null | false | none | CouponSet status which can be: Active, Expired, Inactive System-supplied and read-only. |
| canBeDeleted | boolean | false | none | Signifies that the coupon has not been exported and can be updated ReadOnly |
| maxRedemptionsPerUser | integer(int32)¦null | false | none | Maximum number of times any single user can redeem any code. Must be null, >=1 or -1. Defaults to 1 on creation if null. -1 indicates unlimited. |
| maxRedemptionsPerCouponCode | integer(int32)¦null | false | none | Maximum number of times any code can de used. Must be null, >=1 or -1. Defaults to 1 on creation if null. -1 indicates unlimited. |
| endDate | string(date-time)¦null | false | none | Date and time that the coupon codes becomes expired |
| startDate | string(date-time)¦null | false | none | Date and time that the coupon codes becomes active |
| auditInfo | AuditInfo | false | none | none |
| setSize | integer(int32)¦null | false | none | Sets the number of codes to generate for dynamic coupons Required when CouponCodeType is "Dynamic" |
| couponCodeCount | integer(int32)¦null | false | none | Count of associated couponCodes. Must use "counts" response group to get this value ReadOnly |
| redemptionCount | integer(int32)¦null | false | none | ReadOnly count of all redemptions for this coupon set. |
| assignedDiscountCount | integer(int32)¦null | false | none | ReadOnly sum of all redemptions for this coupon. Use "counts" response group. |
CouponSetCollection
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"id": 0,
"couponSetCode": "string",
"name": "string",
"couponCodeType": "string",
"status": "string",
"canBeDeleted": true,
"maxRedemptionsPerUser": 0,
"maxRedemptionsPerCouponCode": 0,
"endDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"setSize": 0,
"couponCodeCount": 0,
"redemptionCount": 0,
"assignedDiscountCount": 0
}
]
}
Paged collection of Mozu.ProductAdmin.Contracts.CouponSet
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| pageCount | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [CouponSet]¦null | false | none | [Represents a claimable item that allows a user to use one or more discounts.] |
Coupon
{
"couponSetId": 0,
"couponSetCode": "string",
"couponCode": "string",
"canBeDeleted": true,
"redemptionCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Coupon in a coupon set.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| couponSetId | integer(int32) | false | none | ReadOnly system id for releated couponset. |
| couponSetCode | string¦null | false | none | Link to associated coupon |
| couponCode | string | true | none | The code the customer uses to claim this coupon |
| canBeDeleted | boolean | false | none | none |
| redemptionCount | integer(int32)¦null | false | none | Total number of times this code has been redeemed. ReadOnly, calculated. Only returned with response group includeCounts |
| auditInfo | AuditInfo | false | none | none |
CouponCollection
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"couponSetId": 0,
"couponSetCode": "string",
"couponCode": "string",
"canBeDeleted": true,
"redemptionCount": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| pageCount | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [Coupon]¦null | false | none | [Coupon in a coupon set.] |
AssignedDiscount
{
"couponSetCode": "string",
"couponSetId": 0,
"discountId": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| couponSetCode | string¦null | false | none | ReadOnly, CouponSetCode copied from URI |
| couponSetId | integer(int32) | false | none | ReadOnly, CouponSetId |
| discountId | integer(int32) | true | none | Discount Id for the associated discount |
| auditInfo | AuditInfo | false | none | none |
CurrencyLocalization
{
"currencyCode": "string",
"decimalPlaces": 0,
"roundingStrategy": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
A currency and some localization options
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| currencyCode | string¦null | false | none | Currency Code |
| decimalPlaces | integer(int32)¦null | false | none | Number of decimal places to round to |
| roundingStrategy | integer(int32)¦null | false | none | The rounding strategy to use |
| auditInfo | AuditInfo | false | none | none |
CurrencyLocalizationCollection
{
"totalCount": 0,
"items": [
{
"currencyCode": "string",
"decimalPlaces": 0,
"roundingStrategy": 0,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
Non-pages collection of currency-localizations.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| totalCount | integer(int32) | false | none | none |
| items | [CurrencyLocalization]¦null | false | none | [A currency and some localization options] |
CurrencyExchangeRate
{
"fromCurrencyCode": "string",
"toCurrencyCode": "string",
"rate": 0,
"multiplier": 0,
"referenceData": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
The exchange rate between two currencies
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fromCurrencyCode | string¦null | false | none | The source currency code |
| toCurrencyCode | string¦null | false | none | The target currency code |
| rate | number(double) | true | none | The exchange rate |
| multiplier | number(double)¦null | false | none | An additional multiplier to use in calculations |
| referenceData | string¦null | false | none | Reference data for miscellaneous metadata from updates |
| auditInfo | AuditInfo | false | none | none |
CurrencyExchangeRateCollection
{
"totalCount": 0,
"items": [
{
"fromCurrencyCode": "string",
"toCurrencyCode": "string",
"rate": 0,
"multiplier": 0,
"referenceData": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
Non-pages collection of currency-exchange-rates.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| totalCount | integer(int32) | false | none | none |
| items | [CurrencyExchangeRate]¦null | false | none | [The exchange rate between two currencies] |
DiscountLocalizedContent
{
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Container for the language-specific name of the discount. You will have a container for each supported language (LocaleCode). This enables you to display the discount name in multiple languages yet manage it as a single discount internally.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| localeCode | string¦null | false | none | Lanugage used for the discount in the current catalog. Defaults setting for the active catalog. |
| name | string | true | none | Name of the discount. |
| friendlyDescription | string¦null | false | none | Promotional text or HTML that can be utilized as friendly content like "Buy this product now and get X!" |
| auditInfo | AuditInfo | false | none | none |
CategoryDiscountCondition
{
"categoryId": 0
}
Represents a product category and quantity constraint
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| categoryId | integer(int32) | false | none | Unique identifier of the category to which the discount condition applies. |
ProductDiscountCondition
{
"productCode": "string"
}
Represents a product and quantity constraint
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| productCode | string¦null | false | none | Product code of the product to discount. |
CustomerSegment
{
"id": 0
}
Represents a customer segment
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | The Customer segment Id. This is the system Id not the code. |
DiscountCondition
{
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": 0
}
],
"excludedCategories": [
{
"categoryId": 0
}
],
"includedProducts": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"customerSegments": [
{
"id": 0
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": 0
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": "string"
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
}
Specifies constraints that must be satified for a discount to be applied to a target. Constraints are Anded together
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| maxRedemptionCount | integer(int32)¦null | false | none | Maximum number of times that the discount can be redeemed. Default is null (no limit to discount redemptions). |
| requiresCoupon | boolean | false | none | If true, the shopper needs to enter a coupon code to redeem the discount. |
| couponCode | string¦null | false | none | Code of the coupon associated with the discount (if a coupon code is required). The merchant can supply the code or the system can generate it. |
| requiresAuthenticatedUser | boolean | false | none | Determines is this discount can be used by an anonymous user Defaults to false to allow discounts for anonymous users. |
| includedPaymentWorkflows | [string]¦null | false | none | List of payment types that trigger this discount to be valid. |
| includedCategories | [CategoryDiscountCondition]¦null | false | none | List of categories that must be purchased in order for the discount to be valid. |
| excludedCategories | [CategoryDiscountCondition]¦null | false | none | List of categories to discount. When a discount applies to a category, all products in the category are discounted. |
| includedProducts | [ProductDiscountCondition]¦null | false | none | List of products that are eligible for the discount. |
| excludedProducts | [ProductDiscountCondition]¦null | false | none | List of products that are eligible for the discount. |
| customerSegments | [CustomerSegment]¦null | false | none | List of customer groups for which the discount applies |
| minimumQuantityRequiredProducts | integer(int32)¦null | false | none | Minimum quantity of products in the specified IncludedProducts that must be purchased to qualify for the associated discount. Defaults to 1 if null and IncludedProducts has values. |
| minimumQuantityProductsRequiredInCategories | integer(int32)¦null | false | none | Minimum quantity of products in the categories specified in IncludedCategories that must be purchased to qualify for the associated discount. Defaults to 1 if null and IncludedCategories has values |
| minimumOrderAmount | number(double)¦null | false | none | Only applies to order. Minimum order subtotal after discounts in order for the associated discount to be applied |
| maximumOrderAmount | number(double)¦null | false | none | Only applies to order. Maximum order subtotal after discounts in order for the associated discount to be applied |
| categoriesToExcludeFromMinOrderTotal | [CategoryDiscountCondition]¦null | false | none | List of categories to discount. When a discount applies to a category, all products in the category are discounted. |
| productsToExcludeFromMinOrderTotal | [ProductDiscountCondition]¦null | false | none | List of products that are eligible for the discount. |
| minimumLifetimeValueAmount | number(double)¦null | false | none | Minimum lifetime value amount required for this discount to apply |
| startDate | string(date-time)¦null | false | none | Date when the discount can goes into effect, in the format yyyy-mm-dd. |
| expirationDate | string(date-time)¦null | false | none | Date when the discount expires. Default is null (no expiration date). |
| minimumCategorySubtotalBeforeDiscounts | number(double)¦null | false | none | Minimum amount that must be purchased in the combined categories defined in IncludedCategories. Amount is calculated before discounting. Not used if IncludedCategories is empty. |
| minimumRequiredQuantityPerRedemption | integer(int32)¦null | false | none | Defines a minimum quantity that is required for a target only discount |
TargetedCategory
{
"id": 0
}
Category to discount. When a discount applies to a category, all products in the category are discounted.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32)¦null | false | none | Unique identifier of the category to which the discount applies. |
TargetedProduct
{
"productCode": "string"
}
Product to discount.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| productCode | string¦null | false | none | Product code of the product to discount. |
TargetedShippingMethod
{
"code": "string",
"name": "string"
}
Shipping method that is eligible for free shipping. This is the shipping method that is defined with the Shipping Settings resource.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | true | none | Unique identifier of the shipping method as it appears in the SiteShippingMethod property of the Shipping Settings resource. |
| name | string¦null | false | none | Name of the shipping method as it appears in SiteShippingMethodLocalizedContent of the Shipping Settings resource. |
TargetedShippingZone
{
"zone": "string"
}
Shipping method that is eligible for free shipping. This is the shipping method that is defined with the Shipping Settings resource.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| zone | string | true | none | Indicates the shipping zone that this discount is valid for. If zone is provided the method selected must be valid for the zone and both populated in the order for the discount to be valid. |
DiscountTarget
{
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": 0
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": 0
}
],
"products": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "string",
"name": "string"
}
],
"shippingZones": [
{
"zone": "string"
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
}
What to discount. Specifies the type of discount (percentage off, monetary amount, or free shipping) and which products, categories, or shipping methods are eligible for the discount. Can also specify the minimum amount that the order must total for the discount to apply.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | true | none | Type of target to which the discount applies. Possible values: Productor Shipping. If this is a Producttype, you can specify which products or categories that the discount applies to. If this is a Shippingtype then you must specify which shipping methods apply. |
| includeAllProducts | boolean¦null | false | none | If yes, the discount applies to all products sold on the storefront. |
| includedCategoriesOperator | string¦null | false | none | Applies to Included categories When Any, the target product can belong to any specified category. When All, the target product must belong to all specified categories. Defaults to Any |
| categories | [TargetedCategory]¦null | false | none | List of categories to discount. When a discount applies to a category, all products in the category are discounted. |
| excludedCategoriesOperator | string¦null | false | none | Applies to Included categories Defaults to Any |
| excludedCategories | [TargetedCategory]¦null | false | none | List of categories to exclude from the discount. Useful to exclude specific child categories. |
| products | [TargetedProduct]¦null | false | none | List of products that are eligible for the discount. |
| excludedProducts | [TargetedProduct]¦null | false | none | List of products that are excluded from the discount. |
| excludeItemsWithExistingShippingDiscounts | boolean¦null | false | none | Prevents order scoped discounts from layering over items that already have a shipping discount with the same type. |
| excludeItemsWithExistingProductDiscounts | boolean¦null | false | none | Prevents order scoped discounts from layering over items that already have a product discount with the same type. |
| shippingMethods | [TargetedShippingMethod]¦null | false | none | Shipping method that is eligible for shipping discounts. This is a shipping method defined in Shipping Settings. |
| shippingZones | [TargetedShippingZone]¦null | false | none | Shipping Zones that are applicable for this discount |
| maximumQuantityPerRedemption | integer(int32)¦null | false | none | When a condition is specified, this property limits the number of items that can be targeted per discount redemption with an order. if multiple redemptions are allowed per order then multiples of this value would be allowed in multiples of the associated condition. If no condition is specified then this value is not used. If null and condition exists, then defaults to 1. |
| appliesToLeastExpensiveProductsFirst | boolean¦null | false | none | Determines which way the discount is optimized. Consumers favor(default - false/null) or tenants favor (when this is set to true) Applies to discounts where target is not a specific product or list of products. May also impact behavior of Buy X Get Y so that X is the most expensive items and Y the least expensive. |
ThresholdMessageLocalizedContent
{
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| localeCode | string¦null | false | none | Language used for the discount in the current catalog. Defaults setting for the active catalog. |
| messageTemplate | string | true | none | Locale-based contents of the Threshold Message. |
| auditInfo | AuditInfo | false | none | none |
ThresholdMessage
{
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| discountId | integer(int32) | true | none | Unique identifier of the discount. System-supplied and read-only. |
| thresholdValue | number(double) | true | none | The cart total amount that must be met before the threshold message is displayed |
| isActive | boolean | false | none | Indicates if threshold messages are active for this discount |
| showInCart | boolean | false | none | Indicates if the threshold message will display in the cart |
| showOnCheckout | boolean | false | none | Indicates if the threshold message will display on the checkout page |
| requiresCouponCode | boolean | false | none | Indicates if the threshold message will display when a promo code is evaluated |
| content | ThresholdMessageLocalizedContent | true | none | none |
| auditInfo | AuditInfo | false | none | none |
Discount
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": 0
}
],
"excludedCategories": [
{
"categoryId": 0
}
],
"includedProducts": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"customerSegments": [
{
"id": 0
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": 0
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": "string"
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": 0
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": 0
}
],
"products": [
{
"productCode": "string"
}
],
"excludedProducts": [
{
"productCode": "string"
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": "string",
"name": "string"
}
],
"shippingZones": [
{
"zone": "string"
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Allows you to define and manage discounts to apply to your products, product categories, or orders. The discounts can be a specified monetary amount off the price, percentage off the price, or for free shipping. You can create a coupon code that applies to the discount.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32)¦null | false | none | Unique identifier of the discount. System-supplied and read-only. |
| content | DiscountLocalizedContent | true | none | Container for the language-specific name of the discount. You will have a container for each supported language (LocaleCode). This enables you to display the discount name in multiple languages yet manage it as a single discount internally. |
| scope | string | true | none | Scope to which the discount applies, valid values are: Order, LineItem |
| conditions | DiscountCondition | false | none | Specifies constraints that must be satified for a discount to be applied to a target. Constraints are Anded together |
| target | DiscountTarget | true | none | What to discount. Specifies the type of discount (percentage off, monetary amount, or free shipping) and which products, categories, or shipping methods are eligible for the discount. Can also specify the minimum amount that the order must total for the discount to apply. |
| currentRedemptionCount | integer(int32)¦null | false | none | How many times this discount has been redeemed. System-supplied and read-only. |
| amount | number(double)¦null | false | none | Amount of the discount, as a percentage or monetary amount, for example 15% or $15. Must be either null or greater than zero. |
| amountType | string | true | none | Type of discount, which can be either a percentage off the price, a specific monetary amount, or free. Possible values: Percentage Amount Free FixedPrice |
| status | string¦null | false | none | Discount status which can be "Active," "Scheduled," or "Expired." System-supplied and read-only. |
| canBeDeleted | boolean | false | none | Signifies that the discount is not referenced and can be hard deleted |
| doesNotApplyToSalePrice | boolean¦null | false | none | Determines if the discount should apply to sale price or regular price only. Discounts will apply to sale prices by default. Only applies to LineItem product discounts. |
| doesNotApplyToProductsWithSalePrice | boolean¦null | false | none | Determines whether or not a discount applies to a items with a sale price. Applicable on order and line item discounts. For line items, when this is true, the discount will be disqualified. For order level discounts, when true, the discount will not be applied to those items have a sale price. |
| maximumUsesPerUser | integer(int32)¦null | false | none | Maximum number of times a user can redeem this discount. Must be either null or greater than zero. |
| maximumDiscountImpactPerOrder | number(double)¦null | false | none | Maximum impact this discount can apply on a single order. Must be either null or greater than zero. |
| maximumDiscountImpactPerRedemption | number(double)¦null | false | none | Maximum impact this discount can apply on a single line item. Must be either null or greater than zero. |
| maximumRedemptionsPerOrder | integer(int32)¦null | false | none | Maximum number of redemptions allowed per order. If null, defaults to unlimited. |
| includedPriceLists | [string]¦null | false | none | Products receiving a price from a price list specified here or a child of a specified price list can be discounted. |
| doesNotApplyToMultiShipToOrders | boolean¦null | false | none | Flag to allow or prevent application to multi-ship-to orders, Only applicable to shipping discounts. |
| isBxGx | boolean¦null | false | none | Readonly property indicating that the condition required purchase is the same as the target items. Used in BxGx and BoGo type discounts. |
| canBeStackedUpon | boolean¦null | false | none | Indicates whether or not stacking is enabled for this discount |
| stackingLayer | integer(int32)¦null | false | none | Indicates which stacking layer this discount is a part of |
| thresholdMessage | ThresholdMessage | false | none | none |
| preventLineItemShippingDiscounts | boolean¦null | false | none | Prevents Line Item Shipping discounts from being applied when a Line Item Product discount has been applied |
| preventOrderProductDiscounts | boolean¦null | false | none | Prevents Order Product discounts from being applied when a Line Item Product or Shipping discount has been applied |
| preventOrderShippingDiscounts | boolean¦null | false | none | Prevents Order Shipping discounts from being applied when a Line Item Product/Shipping or Order Product discount has been applied |
| hasPurchaseConditions | boolean | false | none | Indicates if this discount has purchase conditions that must be met before the discount is applied |
| purchaseRequirementType | string¦null | false | none | The type of purchase requirement for this discount, either purchase conditions and targets which Supports BoGo, and BxGx scenarios. Or Target only that only have a target and no purchase conditions |
| auditInfo | AuditInfo | false | none | none |
DiscountCollection
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": null
}
],
"excludedCategories": [
{
"categoryId": null
}
],
"includedProducts": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"customerSegments": [
{
"id": null
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": null
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": null
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": null
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": null
}
],
"products": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": null,
"name": null
}
],
"shippingZones": [
{
"zone": null
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
Collection of discounts returned as a whole. A collection is not paged.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| pageCount | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [Discount]¦null | false | none | [Allows you to define and manage discounts to apply to your products, product categories, or orders. The discounts can be a specified monetary amount off the price, percentage off the price, or for free shipping. You can create a coupon code that applies to the discount.] |
StackingConfiguration
{
"stackingEnabled": true,
"productOrderLayers": 0,
"productLineItemLayers": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| stackingEnabled | boolean | false | none | Indicates if discount stacking is enabled for discounts in this catalog |
| productOrderLayers | integer(int32) | false | none | Number of Product Order discount layers |
| productLineItemLayers | integer(int32) | false | none | Number of Product Line Item discount layers |
DiscountSettings
{
"stackingConfiguration": {
"stackingEnabled": true,
"productOrderLayers": 0,
"productLineItemLayers": 0
},
"usePostDiscountedOrderValue": true
}
Tenant level discount settings
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| stackingConfiguration | StackingConfiguration | false | none | none |
| usePostDiscountedOrderValue | boolean¦null | false | none | Use the pre or post line item discounts order total to evaluate the order minimum constraint |
FacetSource
{
"id": "string",
"type": "string",
"name": "string",
"dataType": "string",
"allowsRangeQuery": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string¦null | false | none | Name of field, or FQN of attribute |
| type | string¦null | false | none | The type of source field used by the facet. Allowable values are: Element, Attribute. Must be a valid value for DataType defined in FacetFieldTypeConst. |
| name | string¦null | false | none | Read-only system-generated label for the source field. |
| dataType | string¦null | false | none | Read-only system-generated DataType of the Attribute or Element source field. Will be valid value for DataType defined in DataTypeConst. |
| allowsRangeQuery | boolean | false | none | Read-only system-generated indicator of whether the source field supports RangeQuery type facets. |
FacetValidity
{
"isValid": true,
"reasonCode": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isValid | boolean | false | none | none |
| reasonCode | string¦null | false | none | none |
FacetRangeQuery
{
"rangeValueStart": {},
"rangeValueEnd": {}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| rangeValueStart | object¦null | false | none | none |
| rangeValueEnd | object¦null | false | none | none |
Facet
{
"facetId": 0,
"source": {
"id": "string",
"type": "string",
"name": "string",
"dataType": "string",
"allowsRangeQuery": true
},
"facetType": "string",
"order": 0,
"categoryId": 0,
"valueSortType": "string",
"overrideFacetId": 0,
"isHidden": true,
"validity": {
"isValid": true,
"reasonCode": "string"
},
"rangeQueries": [
{
"rangeValueStart": {},
"rangeValueEnd": {}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
The definition of a Facet
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| facetId | integer(int32)¦null | false | none | The unique identifier for the facet definition |
| source | FacetSource | false | none | none |
| facetType | string¦null | false | none | The type of facet. Allowable values are: Value, RangeQuery Must be a valid value for DataType defined in FacetTypeConst. |
| order | integer(int32) | false | none | Used to order the display of the facets within a section |
| categoryId | integer(int32) | false | none | The category that the facet is being configured at |
| valueSortType | string¦null | false | none | Determines how the facet values will be sorted in the store. Must be a valid value for DataType defined in FacetValueSortTypeConst. Allowable values are: CountAscending, CountDescending, ValuesAscending, ValuesDescending, AttributeDefinition, AttributeDefinitionDescending. The default if no value is specified will be CountDescending. |
| overrideFacetId | integer(int32)¦null | false | none | The ID of a parent category's facet being overriden |
| isHidden | boolean | false | none | Indicates whether the facet is hidden for the given category |
| validity | FacetValidity | false | none | none |
| rangeQueries | [FacetRangeQuery]¦null | false | none | List of ranges if the Facet is of type Range |
| auditInfo | AuditInfo | false | none | none |
FacetSet
{
"configured": [
{
"facetId": 0,
"source": {
"id": "string",
"type": "string",
"name": "string",
"dataType": "string",
"allowsRangeQuery": true
},
"facetType": "string",
"order": 0,
"categoryId": 0,
"valueSortType": "string",
"overrideFacetId": 0,
"isHidden": true,
"validity": {
"isValid": true,
"reasonCode": "string"
},
"rangeQueries": [
{
"rangeValueStart": {},
"rangeValueEnd": {}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"available": [
{
"id": "string",
"type": "string",
"name": "string",
"dataType": "string",
"allowsRangeQuery": true
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| configured | [Facet]¦null | false | none | Facets that are configured |
| available | [FacetSource]¦null | false | none | Facets that are not configured, but COULD BE! |
LocationInventory
{
"locationCode": "string",
"productCode": "string",
"productName": "string",
"stockOnHand": 0,
"stockAvailable": 0,
"stockOnBackOrder": 0,
"baseProductCode": "string",
"sku": "string",
"mfgPartNumber": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
The inventory for a product at a specific Location
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| locationCode | string¦null | false | none | none |
| productCode | string¦null | false | none | none |
| productName | string¦null | false | none | none |
| stockOnHand | integer(int32)¦null | false | none | none |
| stockAvailable | integer(int32)¦null | false | none | none |
| stockOnBackOrder | integer(int32)¦null | false | none | none |
| baseProductCode | string¦null | false | none | none |
| sku | string¦null | false | none | none |
| mfgPartNumber | string¦null | false | none | none |
| auditInfo | AuditInfo | false | none | none |
LocationInventoryCollection
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"locationCode": "string",
"productCode": "string",
"productName": "string",
"stockOnHand": 0,
"stockAvailable": 0,
"stockOnBackOrder": 0,
"baseProductCode": "string",
"sku": "string",
"mfgPartNumber": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
Collection of products returned as a whole. A collection is not paged.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| pageCount | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [LocationInventory]¦null | false | none | [The inventory for a product at a specific Location] |
LocationInventoryAdjustment
{
"productCode": "string",
"locationCode": "string",
"type": "string",
"value": 0
}
Used to modify a product's inventory. This can be an absolute number (number of items in stock) or delta (increase or decrease number of items in stock). StockOnHandAdjustment applies only PUT operations. Possible values: "Absolute" or "Delta."
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| productCode | string¦null | false | none | The ProductCode of the product to adjust only required when updating via locationInventory resource |
| locationCode | string¦null | false | none | The Location code of the product to adjust only required when updating via a sub resource of product |
| type | string¦null | false | none | The type of StockOnHandAdjustment, which can be either Absolute or Delta. Absolute means that Value is the exact number of stock on hand. Delta means that Value is added to or subtracted from the value of StockOnHand. |
| value | integer(int32) | false | none | The absolute or delta value to be applied to StockOnHand. |
MasterCatalog
{
"id": 0,
"name": "string",
"productPublishingMode": "string",
"enableLiveEdit": true,
"isDeleted": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | MasterCatalogId (readonly) |
| name | string¦null | false | none | Name of the MasterCatalog (readonly) |
| productPublishingMode | string¦null | false | none | The product publishing mode of this MasterCatalog |
| enableLiveEdit | boolean¦null | false | none | If the publishingMode is Pending and LiveEditsEnabled = true, DataViewMode live can be passed in the header and live products can be directly edited. |
| isDeleted | boolean | false | none | Indicates whether the MasterCatalog has been deleted and should no longer be used |
MasterCatalogCollection
{
"totalCount": 0,
"items": [
{
"id": 0,
"name": "string",
"productPublishingMode": "string",
"enableLiveEdit": true,
"isDeleted": true
}
]
}
Collection of MasterCatalogs
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| totalCount | integer(int32) | false | none | none |
| items | [MasterCatalog]¦null | false | none | none |
PriceList
{
"priceListCode": "string",
"priceListSequence": 0,
"parentPriceListCode": "string",
"parentPriceListName": "string",
"name": "string",
"description": "string",
"enabled": true,
"filteredInStorefront": true,
"validForAllSites": true,
"validSites": [
0
],
"defaultForSites": [
0
],
"indexedSites": [
0
],
"mappedCustomerSegments": [
"string"
],
"rank": 0,
"resolvable": true,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Category
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| priceListCode | string | true | none | none |
| priceListSequence | integer(int32) | false | none | none |
| parentPriceListCode | string¦null | false | none | Parent PriceList code, Can be null for root level priceLists |
| parentPriceListName | string¦null | false | none | Parent PriceList name, Can be null for root level priceLists. Read only in contract. |
| name | string | true | none | Name of the priceList. Max length is 100 |
| description | string¦null | false | none | Description of the price list. Max length is 300 |
| enabled | boolean¦null | false | none | Is the price list enabled and valid in the storefront. Default is true. |
| filteredInStorefront | boolean¦null | false | none | When true, only products with valid price list entries will be visible in the storefront. Default is false |
| validForAllSites | boolean¦null | false | none | When true, no valid sites need to be specifiied. Price list is considered valid for all sites. Default is true |
| validSites | [integer]¦null | false | none | When ValidForAllSites = false, a list of siteIDs that the price list is valid for should be supplied |
| defaultForSites | [integer]¦null | false | none | none |
| indexedSites | [integer]¦null | false | none | none |
| mappedCustomerSegments | [string]¦null | false | none | List of customer segment code associated with this price list. Used to resolve default price list |
| rank | integer(int32)¦null | false | none | Used to prioritize price list resolution when more than 1 price list maps |
| resolvable | boolean¦null | false | none | Determines if this price list can be resolved as the current price list within a session. |
| auditInfo | AuditInfo | false | none | none |
PriceListCollection
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"priceListCode": "string",
"priceListSequence": 0,
"parentPriceListCode": "string",
"parentPriceListName": "string",
"name": "string",
"description": "string",
"enabled": true,
"filteredInStorefront": true,
"validForAllSites": true,
"validSites": [
0
],
"defaultForSites": [
0
],
"indexedSites": [
0
],
"mappedCustomerSegments": [
"string"
],
"rank": 0,
"resolvable": true,
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
Collection of categories returned as a whole. A collection is not paged.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| pageCount | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [PriceList]¦null | false | none | [Category] |
ProductOptionValue
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
}
A value of a product option for this product. For example, a computer product may have an option called "Memory" that can have the values "6GB,"8GB," and "12GB."
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | object¦null | false | none | none |
| attributeVocabularyValueDetail | AttributeVocabularyValue | false | none | Value of an attribute |
ProductOption
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
Product options for configurable or stand-alone products. A configurable option is one that the shopper chooses when ordering, for example, the color of a T-shirt. A stand-alone option is independent of the product and can be added to the product order. For example, a monogram.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| attributeFQN | string¦null | false | none | Unique identifier of the Attribute. |
| isProductImageGroupSelector | boolean¦null | false | none | Defines whether or not this option can be used to segment product images |
| values | [ProductOptionValue]¦null | false | none | List of all the values for this product option. |
PriceListEntryPrice
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| minQty | integer(int32) | false | none | none |
| listPriceMode | string¦null | false | none | none |
| listPrice | number(double)¦null | false | none | none |
| salePriceMode | string¦null | false | none | none |
| salePrice | number(double)¦null | false | none | none |
PriceListEntryExtra
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
Extra for an entry on a price list
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| attributeFQN | string | true | none | AttributeFQN of the extra ReadOnly |
| value | object¦null | false | none | The value stored with the extra ReadOnly |
| price | number(double) | false | none | PriceList price for the extra |
| attributeCode | string¦null | false | none | AttributeCode. ReadOnly |
| attributeName | string¦null | false | none | Name of attribute that this extra is based on. ReadOnly |
| displayValue | string¦null | false | none | Value to display. Currently only vaild when Value is a string type. ReadOnly |
PriceListEntry
{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Category
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| priceListCode | string¦null | false | none | External unique identifier of the PriceList. Must be unique an only contain url sanitized characters. Max length is 50 |
| priceListEntrySequence | integer(int32) | false | none | none |
| productCode | string | true | none | none |
| productName | string¦null | false | none | none |
| isVariation | boolean | false | none | none |
| options | [ProductOption]¦null | false | none | [Product options for configurable or stand-alone products. A configurable option is one that the shopper chooses when ordering, for example, the color of a T-shirt. A stand-alone option is independent of the product and can be added to the product order. For example, a monogram.] |
| currencyCode | string | true | none | none |
| startDate | string(date-time)¦null | false | none | none |
| endDate | string(date-time)¦null | false | none | none |
| priceListEntryMode | string¦null | false | none | none |
| priceListEntryTypeCode | string¦null | false | none | none |
| discountsRestrictedMode | string¦null | false | none | none |
| discountsRestricted | boolean¦null | false | none | none |
| discountsRestrictedStartDate | string(date-time)¦null | false | none | none |
| discountsRestrictedEndDate | string(date-time)¦null | false | none | none |
| msrpMode | string¦null | false | none | none |
| msrp | number(double)¦null | false | none | none |
| mapMode | string¦null | false | none | none |
| map | number(double)¦null | false | none | none |
| mapStartDate | string(date-time)¦null | false | none | none |
| mapEndDate | string(date-time)¦null | false | none | none |
| costMode | string¦null | false | none | none |
| cost | number(double)¦null | false | none | none |
| priceEntries | [PriceListEntryPrice]¦null | false | none | none |
| extraEntries | [PriceListEntryExtra]¦null | false | none | [Extra for an entry on a price list] |
| auditInfo | AuditInfo | false | none | none |
PriceListEntryCollection
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"priceListCode": "string",
"priceListEntrySequence": 0,
"productCode": "string",
"productName": "string",
"isVariation": true,
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{}
]
}
],
"currencyCode": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"priceListEntryMode": "string",
"priceListEntryTypeCode": "string",
"discountsRestrictedMode": "string",
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"msrpMode": "string",
"msrp": 0,
"mapMode": "string",
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"costMode": "string",
"cost": 0,
"priceEntries": [
{
"minQty": 0,
"listPriceMode": "string",
"listPrice": 0,
"salePriceMode": "string",
"salePrice": 0
}
],
"extraEntries": [
{
"attributeFQN": "string",
"value": {},
"price": 0,
"attributeCode": "string",
"attributeName": "string",
"displayValue": "string"
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
Collection of categories returned as a whole. A collection is not paged.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| pageCount | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [PriceListEntry]¦null | false | none | [Category] |
ProductLocalizedImage
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
Contains the image label and alternate text for a product image or video in the language specified by LocalCode.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32)¦null | false | none | Unique identifier of the image. System-supplied and read-only. |
| localeCode | string¦null | false | none | Language used for the image content. |
| imageLabel | string¦null | false | none | Image title that appears on the storefront. |
| altText | string¦null | false | none | Descriptive text associated with the image or video that appears on the storefront. |
| imageUrl | string¦null | false | none | URL of the image. |
| cmsId | string¦null | false | none | Id of the image in the CMS. |
| videoUrl | string¦null | false | none | URL of a video associated with the product. |
| mediaType | string¦null | false | none | Type of media. Used by the client to determine how to render the image or video or what have you. |
| sequence | integer(int32)¦null | false | none | For products with multiple images, the order in which this image appears on the storefront. |
| productImageGroupId | string¦null | false | none | Image group to which this image belongs. Default is null. |
ProductLocalizedContent
{
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
}
Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| localeCode | string¦null | false | none | Lanugage used for product content. Currently, only en_US is supported. |
| productName | string¦null | false | none | Name of the product. |
| productFullDescription | string¦null | false | none | Long description of the product typically used for a product details page. |
| productShortDescription | string¦null | false | none | Brief description of the product typically used when the product is displayed in a list or search results. |
| productImages | [ProductLocalizedImage]¦null | false | none | List of images associated with the product. |
ProductPrice
{
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
}
Price of the product and currency used.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isoCurrencyCode | string¦null | false | none | Currency code. |
| price | number(double)¦null | false | none | Price of the product. This is the price the merchant intends to sell the product if no sale price is present. |
| salePrice | number(double)¦null | false | none | Current sale price of the product. Sale price is a numeric (monetary) amount, not a percentage off. |
| msrp | number(double)¦null | false | none | Manufacturer Suggested Retail Price. + |
| map | number(double)¦null | false | none | Minimum Advertised Price |
| mapStartDate | string(date-time)¦null | false | none | Minimum Advertised Price effective start date (null = begining of time) |
| mapEndDate | string(date-time)¦null | false | none | Minimum Advertised Price effectivity end date (null = forever) |
| creditValue | number(double)¦null | false | none | Credit amt of the product |
ProductLocalizedSEOContent
{
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
}
Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| localeCode | string¦null | false | none | Lanugage used for product content. Currently, only en_US is supported. |
| metaTagTitle | string¦null | false | none | Metadata title. Metadata can be used to manage information internally. Sometimes used for SEO. |
| metaTagDescription | string¦null | false | none | Metadata description. Metadata can be used to manage information internally. Sometimes used for SEO. |
| metaTagKeywords | string¦null | false | none | Metadata keywords. Metadata can be used to manage information internally. Sometimes used for SEO. |
| titleTagTitle | string¦null | false | none | Used to customize the HTML title tag within the head section of the product details page |
| seoFriendlyUrl | string¦null | false | none | Human-readable identifier that you can give to the product to create friendly URLs. For example, instead of "http: //example.com/products?category=2&id=25," the friendly URL can be "http: //example.com/products/category/2/25." |
ProductCategory
{
"categoryId": 0
}
Categories to which the product belongs.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| categoryId | integer(int32) | false | none | Unique identifier of the category. System-supplied and read-only. |
ActiveDateRange
{
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
}
Active Effectivity Dates
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startDate | string(date-time)¦null | false | none | none |
| endDate | string(date-time)¦null | false | none | none |
ProductInCatalogInfo
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| catalogId | integer(int32) | false | none | The CatalogId of the catalog that the product is associated with (The catalog must a valid catalog within the MasterCatalog that the product belongs to) |
| isActive | boolean¦null | false | none | If true, the product is marked as available for sale in the catalog. Setting a product to IsActive = false will prevent it from being shown on the customer facing storefront. |
| isContentOverridden | boolean¦null | false | none | If true, the content for this product is overridden in the catalog. If false, the MasterCatalog level content will be used for the product. |
| content | ProductLocalizedContent | false | none | Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally. |
| isPriceOverridden | boolean¦null | false | none | If true, the price for this product is overridden in the catalog. If false, the MasterCatalog level price will be used for the product. |
| price | ProductPrice | false | none | Price of the product and currency used. |
| isSeoContentOverridden | boolean¦null | false | none | If true, the SEO content for this product is overridden in the catalog. If false, the MasterCatalog level SEO content will be used for the product. |
| seoContent | ProductLocalizedSEOContent | false | none | Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally. |
| productCategories | [ProductCategory]¦null | false | none | Categories to which the product belongs for this catalog. |
| primaryProductCategory | ProductCategory | false | none | Categories to which the product belongs. |
| dateFirstAvailableInCatalog | string(date-time)¦null | false | none | Date this product was first Available for sale in the catalog. This is utilized in expressions that reference DaysInCatloag. |
| activeDateRange | ActiveDateRange | false | none | Active Effectivity Dates |
| auditInfo | AuditInfo | false | none | none |
ProductPricingBehaviorInfo
{
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"variationPricingMethod": "string"
}
Pricing behavior associated with the product
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| discountsRestricted | boolean¦null | false | none | none |
| discountsRestrictedStartDate | string(date-time)¦null | false | none | none |
| discountsRestrictedEndDate | string(date-time)¦null | false | none | none |
| variationPricingMethod | string¦null | false | none | Only used when product is a variation |
ProductExtraValueDeltaPrice
{
"currencyCode": "string",
"deltaPrice": 0
}
How much a product option costs above the cost of the base product, if at all.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| currencyCode | string¦null | false | none | Which currency to use. |
| deltaPrice | number(double) | false | none | Amount of money saved when discounts are applied. |
ProductExtraValue
{
"value": {},
"deltaPrice": {
"currencyCode": "string",
"deltaPrice": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"deltaPrice": 0
}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
}
A value of a product option for this product. For example, a computer product may have an option called "Memory" that can have the values "6GB,"8GB," and "12GB."
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | object¦null | false | none | none |
| deltaPrice | ProductExtraValueDeltaPrice | false | none | How much a product option costs above the cost of the base product, if at all. |
| localizedDeltaPrice | [ProductExtraValueDeltaPrice]¦null | false | none | [How much a product option costs above the cost of the base product, if at all.] |
| deltaWeight | number(double)¦null | false | none | none |
| isDefaulted | boolean¦null | false | none | none |
| quantity | integer(int32)¦null | false | none | none |
| attributeVocabularyValueDetail | AttributeVocabularyValue | false | none | Value of an attribute |
ProductExtra
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": "string",
"deltaPrice": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"deltaPrice": 0
}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
Product options for configurable or stand-alone products. A configurable option is one that the shopper chooses when ordering, for example, the color of a T-shirt. A stand-alone option is independent of the product and can be added to the product order. For example, a monogram.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| attributeFQN | string¦null | false | none | Unique identifier of the Attribute. |
| isRequired | boolean¦null | false | none | none |
| isMultiSelect | boolean¦null | false | none | none |
| values | [ProductExtraValue]¦null | false | none | [A value of a product option for this product. For example, a computer product may have an option called "Memory" that can have the values "6GB,"8GB," and "12GB."] |
ProductPropertyValueLocalizedContent
{
"localeCode": "string",
"stringValue": "string"
}
Attribute Value Localized Resource
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| localeCode | string¦null | false | none | Language used for the string attribute value. |
| stringValue | string¦null | false | none | Localized Value in the language of the locale code |
ProductPropertyValue
{
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
}
A value of a product option for this product. For example, a computer product may have an option called "Memory" that can have the values "6GB,"8GB," and "12GB."
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | object¦null | false | none | none |
| content | ProductPropertyValueLocalizedContent | false | none | Attribute Value Localized Resource |
| localizedContent | [ProductPropertyValueLocalizedContent]¦null | false | none | [Attribute Value Localized Resource] |
| attributeVocabularyValueDetail | AttributeVocabularyValue | false | none | Value of an attribute |
ProductProperty
{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"attributeVocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
]
}
Product options for configurable or stand-alone products. A configurable option is one that the shopper chooses when ordering, for example, the color of a T-shirt. A stand-alone option is independent of the product and can be added to the product order. For example, a monogram.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| attributeFQN | string¦null | false | none | Unique identifier of the Attribute. |
| values | [ProductPropertyValue]¦null | false | none | [A value of a product option for this product. For example, a computer product may have an option called "Memory" that can have the values "6GB,"8GB," and "12GB."] |
ProductInventoryInfo
{
"manageStock": true,
"outOfStockBehavior": "string"
}
Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| manageStock | boolean¦null | false | none | If true, the Products service manages inventory for this product. |
| outOfStockBehavior | string¦null | false | none | The behvior when the ManageStock is true and the product is not in stock. |
ProductCost
{
"isoCurrencyCode": "string",
"cost": 0
}
Price of the product and currency used.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isoCurrencyCode | string¦null | false | none | Currency code. |
| cost | number(double)¦null | false | none | Cost of the product. This is the price the merchant pays for the product. |
ProductSupplierInfo
{
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
}
Supplier info for the product
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| mfgPartNumber | string¦null | false | none | none |
| distPartNumber | string¦null | false | none | none |
| cost | ProductCost | false | none | Price of the product and currency used. |
Measurement
{
"unit": "string",
"value": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| unit | string¦null | false | none | none |
| value | number(double)¦null | false | none | none |
ProductVariationOption
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
}
}
An option for a product variation. For example, a T-shirt with size and color configurable options, might have a product variation option of "size" or "color."
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| attributeFQN | string¦null | false | none | Unique identifier of the product variation option. System-supplied and read-only. |
| value | object¦null | false | none | Name of the product variation option used on the admin side independent of how it appears on the storefront. For example, the internal "SZ" attribute might appear as "size" on the storefront. |
| content | AttributeVocabularyValueLocalizedContent | false | none | Attribute Value Localized Resource |
ProductPublishingInfo
{
"publishedState": "string",
"lastPublishedBy": "string",
"lastPublishedDate": "2019-08-24T14:15:22Z",
"publishSetCode": "string"
}
Price of the product and currency used.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| publishedState | string¦null | false | none | none |
| lastPublishedBy | string¦null | false | none | none |
| lastPublishedDate | string(date-time)¦null | false | none | none |
| publishSetCode | string¦null | false | none | none |
BundledProduct
{
"productCode": "string",
"quantity": 0,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"productName": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"fulfillmentTypesSupported": [
"string"
]
}
Price of the product and currency used.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| productCode | string¦null | false | none | Product Code |
| quantity | integer(int32) | false | none | Qty of the bundled PRoduct |
| price | ProductPrice | false | none | Price of the product and currency used. |
| productName | string¦null | false | none | Read only Name of the BundledProduct |
| packageHeight | Measurement | false | none | none |
| packageWidth | Measurement | false | none | none |
| packageLength | Measurement | false | none | none |
| packageWeight | Measurement | false | none | none |
| fulfillmentTypesSupported | [string]¦null | false | none | Indicates the fulfillment types the product supports. |
ProductImageGroupTag
{
"fqn": "string",
"values": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fqn | string | true | none | none |
| values | [string]¦null | false | none | none |
ProductImageGroup
{
"productImageGroupId": "string",
"productImageGroupTags": [
{
"fqn": "string",
"values": [
"string"
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| productImageGroupId | string | true | none | none |
| productImageGroupTags | [ProductImageGroupTag]¦null | false | none | none |
SlicingSettings
{
"slicingAttributeFqn": "string"
}
Container class for Slicing Settings
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| slicingAttributeFqn | string¦null | false | none | Product option FQN to create slices on |
Product
{
"productCode": "string",
"productUsage": "string",
"fulfillmentTypesSupported": [
"string"
],
"masterCatalogId": 0,
"productSequence": 0,
"productTypeId": 0,
"isValidForProductType": true,
"baseProductCode": "string",
"productInCatalogs": [
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": null,
"localeCode": null,
"imageLabel": null,
"altText": null,
"imageUrl": null,
"cmsId": null,
"videoUrl": null,
"mediaType": null,
"sequence": null,
"productImageGroupId": null
}
]
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"productCategories": [
{
"categoryId": 0
}
],
"primaryProductCategory": {
"categoryId": 0
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": 0,
"localeCode": "string",
"imageLabel": "string",
"altText": "string",
"imageUrl": "string",
"cmsId": "string",
"videoUrl": "string",
"mediaType": "string",
"sequence": 0,
"productImageGroupId": "string"
}
]
},
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"variationPricingMethod": "string"
},
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{
"value": {},
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"extras": [
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{
"value": {},
"deltaPrice": {
"currencyCode": null,
"deltaPrice": null
},
"localizedDeltaPrice": [
{}
],
"deltaWeight": 0,
"isDefaulted": true,
"quantity": 0,
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"properties": [
{
"attributeFQN": "string",
"values": [
{
"value": {},
"content": {
"localeCode": null,
"stringValue": null
},
"localizedContent": [
{}
],
"attributeVocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
]
}
],
"isTaxable": true,
"inventoryInfo": {
"manageStock": true,
"outOfStockBehavior": "string"
},
"shippingClassId": 0,
"isRecurring": true,
"upc": "string",
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
},
"isPackagedStandAlone": true,
"standAlonePackageType": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"applicableDiscounts": [
{
"id": 0,
"content": {
"localeCode": "string",
"name": "string",
"friendlyDescription": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"scope": "string",
"conditions": {
"maxRedemptionCount": 0,
"requiresCoupon": true,
"couponCode": "string",
"requiresAuthenticatedUser": true,
"includedPaymentWorkflows": [
"string"
],
"includedCategories": [
{
"categoryId": null
}
],
"excludedCategories": [
{
"categoryId": null
}
],
"includedProducts": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"customerSegments": [
{
"id": null
}
],
"minimumQuantityRequiredProducts": 0,
"minimumQuantityProductsRequiredInCategories": 0,
"minimumOrderAmount": 0,
"maximumOrderAmount": 0,
"categoriesToExcludeFromMinOrderTotal": [
{
"categoryId": null
}
],
"productsToExcludeFromMinOrderTotal": [
{
"productCode": null
}
],
"minimumLifetimeValueAmount": 0,
"startDate": "2019-08-24T14:15:22Z",
"expirationDate": "2019-08-24T14:15:22Z",
"minimumCategorySubtotalBeforeDiscounts": 0,
"minimumRequiredQuantityPerRedemption": 0
},
"target": {
"type": "string",
"includeAllProducts": true,
"includedCategoriesOperator": "string",
"categories": [
{
"id": null
}
],
"excludedCategoriesOperator": "string",
"excludedCategories": [
{
"id": null
}
],
"products": [
{
"productCode": null
}
],
"excludedProducts": [
{
"productCode": null
}
],
"excludeItemsWithExistingShippingDiscounts": true,
"excludeItemsWithExistingProductDiscounts": true,
"shippingMethods": [
{
"code": null,
"name": null
}
],
"shippingZones": [
{
"zone": null
}
],
"maximumQuantityPerRedemption": 0,
"appliesToLeastExpensiveProductsFirst": true
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": 0,
"thresholdValue": 0,
"isActive": true,
"showInCart": true,
"showOnCheckout": true,
"requiresCouponCode": true,
"content": {
"localeCode": "string",
"messageTemplate": "string",
"auditInfo": {}
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
],
"isVariation": true,
"variationKey": "string",
"hasConfigurableOptions": true,
"hasStandAloneOptions": true,
"variationOptions": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
}
}
],
"publishingInfo": {
"publishedState": "string",
"lastPublishedBy": "string",
"lastPublishedDate": "2019-08-24T14:15:22Z",
"publishSetCode": "string"
},
"bundledProducts": [
{
"productCode": "string",
"quantity": 0,
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"productName": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"fulfillmentTypesSupported": [
"string"
]
}
],
"productImageGroups": [
{
"productImageGroupId": "string",
"productImageGroupTags": [
{
"fqn": "string",
"values": [
"string"
]
}
]
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"slicingSettings": {
"slicingAttributeFqn": "string"
}
}
Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| productCode | string¦null | false | none | Merchant-created code indentifier associated with the product, for example, a SKU or product item number. |
| productUsage | string¦null | false | none | Indicates the usage type of this product. Must be one of the values in ProductUsageConst. |
| fulfillmentTypesSupported | [string]¦null | false | none | Indicates the fulfillment types the product supports. |
| masterCatalogId | integer(int32)¦null | false | none | Indentifier of the Master Catalog that this product is a member of. System-supplied and read-only |
| productSequence | integer(int32)¦null | false | none | System generated monotonically increasing sequence |
| productTypeId | integer(int32)¦null | false | none | Unique identifier of the productType of the product. Refers to a valid ProductType that was previously created with the ProductType resource. |
| isValidForProductType | boolean¦null | false | none | Read only flag that indicates if the product meets the product type constraints (All adminRequired attributes have a valid value) |
| baseProductCode | string¦null | false | none | This is the base product ProductCode of a product that is a variation. It is read-only and only populated for products that are variations of a configurable base product. |
| productInCatalogs | [ProductInCatalogInfo]¦null | false | none | Catalog specifc info for each catalog a product is valid in. There should always be one or more entries here. |
| content | ProductLocalizedContent | false | none | Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally. |
| price | ProductPrice | false | none | Price of the product and currency used. |
| pricingBehavior | ProductPricingBehaviorInfo | false | none | Pricing behavior associated with the product |
| seoContent | ProductLocalizedSEOContent | false | none | Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a product in multiple languages yet manage it as a single product internally. |
| options | [ProductOption]¦null | false | none | The Options defined in the product Type that are currently assigned to this product |
| extras | [ProductExtra]¦null | false | none | The Extras defined in the product Type that are currently assigned to this product |
| properties | [ProductProperty]¦null | false | none | The Properties defined in the product Type that are currently assigned to this product |
| isTaxable | boolean¦null | false | none | If true, the product is subject to tax. |
| inventoryInfo | ProductInventoryInfo | false | none | Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs. |
| shippingClassId | integer(int32)¦null | false | none | none |
| isRecurring | boolean¦null | false | none | If true, the product can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription. |
| upc | string¦null | false | none | UPC code of the product. |
| supplierInfo | ProductSupplierInfo | false | none | Supplier info for the product |
| isPackagedStandAlone | boolean¦null | false | none | Does this product need to be packaged on its own |
| standAlonePackageType | string¦null | false | none | When packaged alone this is the package type |
| packageHeight | Measurement | false | none | none |
| packageWidth | Measurement | false | none | none |
| packageLength | Measurement | false | none | none |
| packageWeight | Measurement | false | none | none |
| applicableDiscounts | [Discount]¦null | false | none | Read only. List of discounts that are available for a product. |
| isVariation | boolean | false | none | Read only. If true, this is a product variation of a product with configurable options. System-supplied and read-only. |
| variationKey | string¦null | false | none | Read only. If IsVariation true, thish provides a unique key to manage the variation of the base product. |
| hasConfigurableOptions | boolean | false | none | Read only. If true, this product has configurable options. The product is not purchasable until the shopper selects options that resolve to a product variation. System-supplied and read-only. |
| hasStandAloneOptions | boolean | false | none | Read only. If true, the product has stand-alone options that a shopper may select. System-supplied and read-only. |
| variationOptions | [ProductVariationOption]¦null | false | none | Read only List of variations that exist for a product. This is only populated when IsVariation is true. To get the list of options, the GET request must include the VariationOptions response group. |
| publishingInfo | ProductPublishingInfo | false | none | Price of the product and currency used. |
| bundledProducts | [BundledProduct]¦null | false | none | list of other products that are included in a BundleProduct This requires that the ProductUssage be set to Bundle |
| productImageGroups | [ProductImageGroup]¦null | false | none | List of the image groups this product uses. Image groups are used to map different images to different product options. If the product doesn't have options then all images will be in the default image group. |
| auditInfo | AuditInfo | false | none | none |
| slicingSettings | SlicingSettings | false | none | Container class for Slicing Settings |
ProductCollection
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"productCode": "string",
"productUsage": "string",
"fulfillmentTypesSupported": [
"string"
],
"masterCatalogId": 0,
"productSequence": 0,
"productTypeId": 0,
"isValidForProductType": true,
"baseProductCode": "string",
"productInCatalogs": [
{
"catalogId": 0,
"isActive": true,
"isContentOverridden": true,
"content": {
"localeCode": null,
"productName": null,
"productFullDescription": null,
"productShortDescription": null,
"productImages": null
},
"isPriceOverridden": true,
"price": {
"isoCurrencyCode": null,
"price": null,
"salePrice": null,
"msrp": null,
"map": null,
"mapStartDate": null,
"mapEndDate": null,
"creditValue": null
},
"isSeoContentOverridden": true,
"seoContent": {
"localeCode": null,
"metaTagTitle": null,
"metaTagDescription": null,
"metaTagKeywords": null,
"titleTagTitle": null,
"seoFriendlyUrl": null
},
"productCategories": [
{}
],
"primaryProductCategory": {
"categoryId": null
},
"dateFirstAvailableInCatalog": "2019-08-24T14:15:22Z",
"activeDateRange": {
"startDate": null,
"endDate": null
},
"auditInfo": {
"updateDate": null,
"createDate": null,
"updateBy": null,
"createBy": null
}
}
],
"content": {
"localeCode": "string",
"productName": "string",
"productFullDescription": "string",
"productShortDescription": "string",
"productImages": [
{
"id": null,
"localeCode": null,
"imageLabel": null,
"altText": null,
"imageUrl": null,
"cmsId": null,
"videoUrl": null,
"mediaType": null,
"sequence": null,
"productImageGroupId": null
}
]
},
"price": {
"isoCurrencyCode": "string",
"price": 0,
"salePrice": 0,
"msrp": 0,
"map": 0,
"mapStartDate": "2019-08-24T14:15:22Z",
"mapEndDate": "2019-08-24T14:15:22Z",
"creditValue": 0
},
"pricingBehavior": {
"discountsRestricted": true,
"discountsRestrictedStartDate": "2019-08-24T14:15:22Z",
"discountsRestrictedEndDate": "2019-08-24T14:15:22Z",
"variationPricingMethod": "string"
},
"seoContent": {
"localeCode": "string",
"metaTagTitle": "string",
"metaTagDescription": "string",
"metaTagKeywords": "string",
"titleTagTitle": "string",
"seoFriendlyUrl": "string"
},
"options": [
{
"attributeFQN": "string",
"isProductImageGroupSelector": true,
"values": [
{}
]
}
],
"extras": [
{
"attributeFQN": "string",
"isRequired": true,
"isMultiSelect": true,
"values": [
{}
]
}
],
"properties": [
{
"attributeFQN": "string",
"values": [
{}
]
}
],
"isTaxable": true,
"inventoryInfo": {
"manageStock": true,
"outOfStockBehavior": "string"
},
"shippingClassId": 0,
"isRecurring": true,
"upc": "string",
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
},
"isPackagedStandAlone": true,
"standAlonePackageType": "string",
"packageHeight": {
"unit": "string",
"value": 0
},
"packageWidth": {
"unit": "string",
"value": 0
},
"packageLength": {
"unit": "string",
"value": 0
},
"packageWeight": {
"unit": "string",
"value": 0
},
"applicableDiscounts": [
{
"id": 0,
"content": {
"localeCode": null,
"name": null,
"friendlyDescription": null,
"auditInfo": null
},
"scope": "string",
"conditions": {
"maxRedemptionCount": null,
"requiresCoupon": null,
"couponCode": null,
"requiresAuthenticatedUser": null,
"includedPaymentWorkflows": null,
"includedCategories": null,
"excludedCategories": null,
"includedProducts": null,
"excludedProducts": null,
"customerSegments": null,
"minimumQuantityRequiredProducts": null,
"minimumQuantityProductsRequiredInCategories": null,
"minimumOrderAmount": null,
"maximumOrderAmount": null,
"categoriesToExcludeFromMinOrderTotal": null,
"productsToExcludeFromMinOrderTotal": null,
"minimumLifetimeValueAmount": null,
"startDate": null,
"expirationDate": null,
"minimumCategorySubtotalBeforeDiscounts": null,
"minimumRequiredQuantityPerRedemption": null
},
"target": {
"type": null,
"includeAllProducts": null,
"includedCategoriesOperator": null,
"categories": null,
"excludedCategoriesOperator": null,
"excludedCategories": null,
"products": null,
"excludedProducts": null,
"excludeItemsWithExistingShippingDiscounts": null,
"excludeItemsWithExistingProductDiscounts": null,
"shippingMethods": null,
"shippingZones": null,
"maximumQuantityPerRedemption": null,
"appliesToLeastExpensiveProductsFirst": null
},
"currentRedemptionCount": 0,
"amount": 0,
"amountType": "string",
"status": "string",
"canBeDeleted": true,
"doesNotApplyToSalePrice": true,
"doesNotApplyToProductsWithSalePrice": true,
"maximumUsesPerUser": 0,
"maximumDiscountImpactPerOrder": 0,
"maximumDiscountImpactPerRedemption": 0,
"maximumRedemptionsPerOrder": 0,
"includedPriceLists": [
"string"
],
"doesNotApplyToMultiShipToOrders": true,
"isBxGx": true,
"canBeStackedUpon": true,
"stackingLayer": 0,
"thresholdMessage": {
"discountId": null,
"thresholdValue": null,
"isActive": null,
"showInCart": null,
"showOnCheckout": null,
"requiresCouponCode": null,
"content": null,
"auditInfo": null
},
"preventLineItemShippingDiscounts": true,
"preventOrderProductDiscounts": true,
"preventOrderShippingDiscounts": true,
"hasPurchaseConditions": true,
"purchaseRequirementType": "string",
"auditInfo": {
"updateDate": null,
"createDate": null,
"updateBy": null,
"createBy": null
}
}
],
"isVariation": true,
"variationKey": "string",
"hasConfigurableOptions": true,
"hasStandAloneOptions": true,
"variationOptions": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": null,
"stringValue": null
}
}
],
"publishingInfo": {
"publishedState": "string",
"lastPublishedBy": "string",
"lastPublishedDate": "2019-08-24T14:15:22Z",
"publishSetCode": "string"
},
"bundledProducts": [
{
"productCode": "string",
"quantity": 0,
"price": {
"isoCurrencyCode": null,
"price": null,
"salePrice": null,
"msrp": null,
"map": null,
"mapStartDate": null,
"mapEndDate": null,
"creditValue": null
},
"productName": "string",
"packageHeight": {
"unit": null,
"value": null
},
"packageWidth": {
"unit": null,
"value": null
},
"packageLength": {
"unit": null,
"value": null
},
"packageWeight": {
"unit": null,
"value": null
},
"fulfillmentTypesSupported": [
"string"
]
}
],
"productImageGroups": [
{
"productImageGroupId": "string",
"productImageGroupTags": [
{}
]
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
},
"slicingSettings": {
"slicingAttributeFqn": "string"
}
}
]
}
Collection of products returned as a whole. A collection is not paged.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| pageCount | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [Product]¦null | false | none | [Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.] |
ProductCodeRename
{
"existingProductCode": "string",
"newProductCode": "string"
}
A tuple used to rename the productCode of a product
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| existingProductCode | string¦null | false | none | The existing ProductCode that should be renamed |
| newProductCode | string¦null | false | none | The new ProductCode that will be the result of the rename |
ProductVariationDeltaPrice
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
How much more a product variation costs above the cost of the base product. If the price of the base product changes, this price is adjusted automatically.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| currencyCode | string¦null | false | none | Which currency is in use. |
| value | number(double)¦null | false | none | How much more the variation costs above the cost of the base product. |
| msrp | number(double)¦null | false | none | Manufacturer Suggested Retail Price. |
| creditValue | number(double)¦null | false | none | Credit amt of the product |
ProductVariationFixedPrice
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| currencyCode | string¦null | false | none | Which currency is in use. |
| listPrice | number(double)¦null | false | none | Variation price for fixed pricing |
| salePrice | number(double)¦null | false | none | Variation sale price whne fixed pricing |
| msrp | number(double)¦null | false | none | Manufacturer Suggested Retail Price. |
| creditValue | number(double)¦null | false | none | Credit amt of the product |
ProductVariation
{
"isActive": true,
"isOrphan": true,
"variationExists": true,
"variationkey": "string",
"variationProductCode": "string",
"deltaPrice": {
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
],
"fixedPrice": {
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
},
"localizedFixedPrice": [
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
],
"deltaWeight": 0,
"fixedWeight": 0,
"options": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": "string",
"stringValue": "string"
}
}
],
"upc": "string",
"fulfillmentTypesSupported": [
"string"
],
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
}
}
The ProductVariation resource helps merchants manage their products with configurable options. Using this reasource, the system creates a matrix of all possible combinations of the product options and the merchant confirms which variations match products for sale. For example, a T-shirt with three color and three size options has nine possible product variations. The system keeps track of inventory for each variation.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isActive | boolean¦null | false | none | If true, the merchant accepts the variation generated from the configurable options as a product offering. If IsActive is false then the product variation is not for sale--either because it was never a product offering or it was permanently dropped. IsActive is not intended for temporary unavailability. Default is false. |
| isOrphan | boolean¦null | false | none | If true, the variation is no longer possible. The system sets IsOrphan to true when the merchant has changed something to make this variation impossible. For example, if the merchant stopped selling all "small" shirts, all product variations with the "small" option are set to IsOrphan. System-supplied and read-only. |
| variationExists | boolean¦null | false | none | If true, the product variation exists. When the merchant sets IsActive to true, the system sets VariationExists to true and creates a Variation Key as a unique identifier for this variation. System-supplied and read-only. |
| variationkey | string¦null | false | none | Unique identifier for a single variation ("small" + "red" + "short-sleeved"). System-supplied and read-only. |
| variationProductCode | string¦null | false | none | Descriptive code to refer to a single variation. Typically this is a sequence appended to the base ProduceCode. A merchant can create this code to easily recognize a product variation. By default, the system creates this code by appending a number to the base product. After the merchant supplies this code, it becomes read-only. |
| deltaPrice | ProductVariationDeltaPrice | false | none | How much more a product variation costs above the cost of the base product. If the price of the base product changes, this price is adjusted automatically. |
| localizedDeltaPrice | [ProductVariationDeltaPrice]¦null | false | none | How much more the variation costs above the cost of the base product. If the price of the base product changes, this price is adjusted accordingly. This collection allows for multiple currencies. |
| fixedPrice | ProductVariationFixedPrice | false | none | none |
| localizedFixedPrice | [ProductVariationFixedPrice]¦null | false | none | Price of the variation using fixed per currency This collection allows for multiple currencies. |
| deltaWeight | number(double)¦null | false | none | Weight of the product with this variation. |
| fixedWeight | number(double)¦null | false | none | Fixed weight of the product with this variation. |
| options | [ProductVariationOption]¦null | false | none | List of values for this product variation: such as "small, "red.. these are read only here as the variationKey defines the values " |
| upc | string¦null | false | none | Price Lookup Unit code for the product |
| fulfillmentTypesSupported | [string]¦null | false | none | Indicates the fulfillment types the product supports. |
| supplierInfo | ProductSupplierInfo | false | none | Supplier info for the product |
ProductVariationPagedCollection
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"isActive": true,
"isOrphan": true,
"variationExists": true,
"variationkey": "string",
"variationProductCode": "string",
"deltaPrice": {
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
],
"fixedPrice": {
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
},
"localizedFixedPrice": [
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
],
"deltaWeight": 0,
"fixedWeight": 0,
"options": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": null,
"stringValue": null
}
}
],
"upc": "string",
"fulfillmentTypesSupported": [
"string"
],
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
}
}
]
}
Collection of product variations where the variations are returned in a series of pages.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| pageCount | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [ProductVariation]¦null | false | none | [The ProductVariation resource helps merchants manage their products with configurable options. Using this reasource, the system creates a matrix of all possible combinations of the product options and the merchant confirms which variations match products for sale. For example, a T-shirt with three color and three size options has nine possible product variations. The system keeps track of inventory for each variation.] |
ProductVariationCollection
{
"totalCount": 0,
"items": [
{
"isActive": true,
"isOrphan": true,
"variationExists": true,
"variationkey": "string",
"variationProductCode": "string",
"deltaPrice": {
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
},
"localizedDeltaPrice": [
{
"currencyCode": "string",
"value": 0,
"msrp": 0,
"creditValue": 0
}
],
"fixedPrice": {
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
},
"localizedFixedPrice": [
{
"currencyCode": "string",
"listPrice": 0,
"salePrice": 0,
"msrp": 0,
"creditValue": 0
}
],
"deltaWeight": 0,
"fixedWeight": 0,
"options": [
{
"attributeFQN": "string",
"value": {},
"content": {
"localeCode": null,
"stringValue": null
}
}
],
"upc": "string",
"fulfillmentTypesSupported": [
"string"
],
"supplierInfo": {
"mfgPartNumber": "string",
"distPartNumber": "string",
"cost": {
"isoCurrencyCode": "string",
"cost": 0
}
}
}
]
}
Collection of product variations returned as a whole. A collection is not paged.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| totalCount | integer(int32) | false | none | none |
| items | [ProductVariation]¦null | false | none | [The ProductVariation resource helps merchants manage their products with configurable options. Using this reasource, the system creates a matrix of all possible combinations of the product options and the merchant confirms which variations match products for sale. For example, a T-shirt with three color and three size options has nine possible product variations. The system keeps track of inventory for each variation.] |
ProductSortExpression
{
"field": "string",
"direction": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| field | string | true | none | The name of the field to sort on. Must be a known sort field or sortable attribute |
| direction | string¦null | false | none | ASC or DESC |
ProductSortOverride
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
Represents a product that is positioned out of its normal sort position. It can be boosted to the top of the list, positioned exactly or buried at the bottom
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| productCode | string | true | none | The product code of the product being overridden |
| sliceValue | string¦null | false | none | The slicing value of the product being overridden |
| position | integer(int32)¦null | false | none | Indicates the relative position of the product to other overridden products. Position is absolute if IsPinned is true. Not applicable to buried products. Buried products will be given a default position of -1 |
| isPinned | boolean¦null | false | none | Flag to indicate that the product is pinned at the specified position. Not applicable to buried products |
ProductSortDefinition
{
"productSortDefinitionId": 0,
"categoryId": 0,
"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"sortExpressions": [
{
"field": "string",
"direction": "string"
}
],
"boosted": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"buried": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Defines a default sort for a list of products and allows some products to be boosted to the top or pinned ot a specific position, or buried at the bottom of the list. Only 10 items can be boosted or pinned and up to
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| productSortDefinitionId | integer(int32)¦null | false | none | System or user provided ID for the ProductSortDefinition |
| categoryId | integer(int32)¦null | false | none | none |
| name | string | true | none | Short Name for the sort definition. Required. |
| startDate | string(date-time) | true | none | The Start Date when the sort definition becomes active |
| endDate | string(date-time)¦null | false | none | Optional end date for a product sort definition |
| sortExpressions | [ProductSortExpression] | true | none | Sort expression to apply Max two expressions |
| boosted | [ProductSortOverride]¦null | false | none | List of products being positioned |
| buried | [ProductSortOverride]¦null | false | none | List of products being positioned |
| auditInfo | AuditInfo | false | none | none |
ProductSortDefinitionPagedCollection
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"productSortDefinitionId": 0,
"categoryId": 0,
"name": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"sortExpressions": [
{
"field": "string",
"direction": "string"
}
],
"boosted": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"buried": [
{
"productCode": "string",
"sliceValue": "string",
"position": 0,
"isPinned": true
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
Collection of product sort definitions where product sort definitions are returned in a series of pages.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| pageCount | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [ProductSortDefinition]¦null | false | none | [Defines a default sort for a list of products and allows some products to be boosted to the top or pinned ot a specific position, or buried at the bottom of the list. Only 10 items can be boosted or pinned and up to] |
AttributeInProductTypeDisplayInfo
{
"displayIntention": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| displayIntention | string¦null | false | none | Defines the intended display of this Attribute in the storeFront (ex. DropDown, ImagePicker, RadioButtons....) |
AttributeVocabularyValueDisplayInfo
{
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cmsId | string¦null | false | none | Id of the image in the CMS. |
| imageUrl | string¦null | false | none | URL of the image. |
| colorValue | string¦null | false | none | Hex Color value to display in a color picker |
AttributeVocabularyValueInProductType
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": "string",
"stringValue": "string"
}
],
"displayOrder": 0
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | object¦null | false | none | The actual value of the attribute vocabulary. This must be an existing value defined in the attribute vocabulary |
| order | integer(int32)¦null | false | none | Used to order the display of the attribute values in the storefront.... |
| displayInfo | AttributeVocabularyValueDisplayInfo | false | none | none |
| vocabularyValueDetail | AttributeVocabularyValue | false | none | Value of an attribute |
AttributeInProductType
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": "string",
"imageUrl": "string",
"colorValue": "string"
},
"vocabularyValueDetail": {
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": "string",
"value": "string"
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": "string",
"name": "string",
"description": "string"
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": 0,
"value": {},
"mappedGenericValues": [
{}
],
"productName": "string",
"content": {
"localeCode": "string",
"stringValue": "string"
},
"localizedContent": [
{
"localeCode": null,
"stringValue": null
}
],
"displayOrder": 0
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| attributeFQN | string¦null | false | none | Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed |
| isInheritedFromBaseType | boolean¦null | false | none | If True, the attribute is part of the base product type and can only have order modified. |
| order | integer(int32)¦null | false | none | Used to order the display of the attributes within a section |
| isRequiredByAdmin | boolean¦null | false | none | If True, the admin must include this attribute in products of this productType |
| isHiddenProperty | boolean¦null | false | none | If True, the property is hidden in the storefront. This field only applies to properties. |
| isAdminOnlyProperty | boolean¦null | false | none | If true, this property is not available on the storefront. If false, this property will be available on storefront. The IsHiddenProperty hides the property from the customer, but is still available from the API. |
| isProductDetailsOnlyProperty | boolean¦null | false | none | If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...) |
| isMultiValueProperty | boolean¦null | false | none | If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties. |
| displayInfo | AttributeInProductTypeDisplayInfo | false | none | none |
| vocabularyValues | [AttributeVocabularyValueInProductType]¦null | false | none | The collection of vocabulary values included in this product type. |
| attributeDetail | Attribute | false | none | Attribute |
ProductType
{
"id": 0,
"name": "string",
"masterCatalogId": 0,
"isBaseProductType": true,
"productCount": 0,
"productUsages": [
"string"
],
"goodsType": "string",
"options": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"extras": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"properties": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": "string"
},
"vocabularyValues": [
{
"value": {},
"order": 0,
"displayInfo": {
"cmsId": null,
"imageUrl": null,
"colorValue": null
},
"vocabularyValueDetail": {
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
}
],
"attributeDetail": {
"adminName": "string",
"namespace": "string",
"attributeCode": "string",
"attributeFQN": "string",
"isValueMappingAttribute": true,
"valueMappingAttributeFQN": "string",
"attributeSequence": 0,
"attributeDataTypeSequence": 0,
"masterCatalogId": 0,
"inputType": "string",
"valueType": "string",
"dataType": "string",
"isOption": true,
"isExtra": true,
"isProperty": true,
"attributeMetadata": [
{
"key": null,
"value": null
}
],
"content": {
"localeCode": "string",
"name": "string",
"description": "string"
},
"localizedContent": [
{
"localeCode": null,
"name": null,
"description": null
}
],
"validation": {
"regularExpression": "string",
"minStringLength": 0,
"maxStringLength": 0,
"minNumericValue": 0,
"maxNumericValue": 0,
"minDateValue": "2019-08-24T14:15:22Z",
"maxDateValue": "2019-08-24T14:15:22Z"
},
"vocabularyValues": [
{
"valueSequence": null,
"value": null,
"mappedGenericValues": null,
"productName": null,
"content": null,
"localizedContent": null,
"displayOrder": null
}
],
"searchSettings": {
"searchableInStorefront": true,
"searchableInAdmin": true,
"searchDisplayValue": true,
"allowFilteringAndSortingInStorefront": true,
"indexValueWithCase": true,
"customWeightInStorefrontSearch": true
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32)¦null | false | none | Unique identifier of the ProductType. System-supplied and read-only. |
| name | string¦null | false | none | Name of the productType |
| masterCatalogId | integer(int32)¦null | false | none | Indentifier of the Master Catalog that this ProductType is a member of. System-supplied and read-only. |
| isBaseProductType | boolean | false | none | System supplied and read only. There is only one BaseProductType per MasterCatalog. |
| productCount | integer(int32)¦null | false | none | Indicates the number of products currently using this Product Type. System-supplied and read-only. |
| productUsages | [string]¦null | false | none | List of ProductUsages supported by the ProductType. |
| goodsType | string¦null | false | none | The TYpe of Goods of this product |
| options | [AttributeInProductType]¦null | false | none | Collection of the Attributes that are Options in this productType |
| extras | [AttributeInProductType]¦null | false | none | Collection of the Attributes that are Extras in this productType |
| properties | [AttributeInProductType]¦null | false | none | Collection of the Attributes that are Properties in this productType |
| auditInfo | AuditInfo | false | none | none |
ProductTypeCollection
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"id": 0,
"name": "string",
"masterCatalogId": 0,
"isBaseProductType": true,
"productCount": 0,
"productUsages": [
"string"
],
"goodsType": "string",
"options": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": null
},
"vocabularyValues": [
{}
],
"attributeDetail": {
"adminName": null,
"namespace": null,
"attributeCode": null,
"attributeFQN": null,
"isValueMappingAttribute": null,
"valueMappingAttributeFQN": null,
"attributeSequence": null,
"attributeDataTypeSequence": null,
"masterCatalogId": null,
"inputType": null,
"valueType": null,
"dataType": null,
"isOption": null,
"isExtra": null,
"isProperty": null,
"attributeMetadata": null,
"content": null,
"localizedContent": null,
"validation": null,
"vocabularyValues": null,
"searchSettings": null,
"auditInfo": null
}
}
],
"extras": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": null
},
"vocabularyValues": [
{}
],
"attributeDetail": {
"adminName": null,
"namespace": null,
"attributeCode": null,
"attributeFQN": null,
"isValueMappingAttribute": null,
"valueMappingAttributeFQN": null,
"attributeSequence": null,
"attributeDataTypeSequence": null,
"masterCatalogId": null,
"inputType": null,
"valueType": null,
"dataType": null,
"isOption": null,
"isExtra": null,
"isProperty": null,
"attributeMetadata": null,
"content": null,
"localizedContent": null,
"validation": null,
"vocabularyValues": null,
"searchSettings": null,
"auditInfo": null
}
}
],
"properties": [
{
"attributeFQN": "string",
"isInheritedFromBaseType": true,
"order": 0,
"isRequiredByAdmin": true,
"isHiddenProperty": true,
"isAdminOnlyProperty": true,
"isProductDetailsOnlyProperty": true,
"isMultiValueProperty": true,
"displayInfo": {
"displayIntention": null
},
"vocabularyValues": [
{}
],
"attributeDetail": {
"adminName": null,
"namespace": null,
"attributeCode": null,
"attributeFQN": null,
"isValueMappingAttribute": null,
"valueMappingAttributeFQN": null,
"attributeSequence": null,
"attributeDataTypeSequence": null,
"masterCatalogId": null,
"inputType": null,
"valueType": null,
"dataType": null,
"isOption": null,
"isExtra": null,
"isProperty": null,
"attributeMetadata": null,
"content": null,
"localizedContent": null,
"validation": null,
"vocabularyValues": null,
"searchSettings": null,
"auditInfo": null
}
}
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
Collection of attributes.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| pageCount | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [ProductType]¦null | false | none | none |
PublishingScope
{
"allPending": true,
"productCodes": [
"string"
],
"publishSetCode": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| allPending | boolean¦null | false | none | True = scope to all pending products |
| productCodes | [string]¦null | false | none | List of specific productCodes to scope publish operation against |
| publishSetCode | string¦null | false | none | The Publish Set to publish |
PublishSet
{
"code": "string",
"productCount": 0,
"productCodes": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string¦null | false | none | The PublishSet unique identifier |
| productCount | integer(int32) | false | none | Number of product drafts that are included in the publish set |
| productCodes | [string]¦null | false | none | List of specific product codes that are included in the publish set |
PublishSetCollection
{
"totalCount": 0,
"items": [
{
"code": "string",
"productCount": 0,
"productCodes": [
"string"
]
}
]
}
Non-paged collection of PublishSets.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| totalCount | integer(int32) | false | none | none |
| items | [PublishSet]¦null | false | none | none |
SynonymDefinition
{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| synonymId | integer(int32)¦null | false | none | The unique identifier for the synonym definition |
| key | string¦null | false | none | If key is defined then map is directed |
| synonyms | [string]¦null | false | none | List of synonyms. If no key is defined the matches are bidirectional |
SynonymDefinitionCollection
{
"tenantId": 0,
"siteId": 0,
"localeCode": "string",
"synonymDefinitions": [
{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}
]
}
Non-paged collection of all synonyms for a Site-Locale. Used for bulk operations
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| tenantId | integer(int32) | false | none | Read-only TenantId |
| siteId | integer(int32) | false | none | Read-only Site Id |
| localeCode | string¦null | false | none | The locale code to which this definition applies |
| synonymDefinitions | [SynonymDefinition]¦null | false | none | List of mappings for this definition |
SynonymDefinitionPagedCollection
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"synonymId": 0,
"key": "string",
"synonyms": [
"string"
]
}
]
}
Paged collection of synonyms for a Site-Locale.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| pageCount | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [SynonymDefinition]¦null | false | none | none |
SearchTuningRuleFilter
{
"field": "string",
"value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| field | string¦null | false | none | none |
| value | string¦null | false | none | none |
SearchTuningRule
{
"siteId": 0,
"searchTuningRuleCode": "string",
"searchTuningRuleName": "string",
"searchTuningRuleDescription": "string",
"keywords": [
"string"
],
"filters": [
{
"field": "string",
"value": "string"
}
],
"active": true,
"isDefault": true,
"activeStartDate": "2019-08-24T14:15:22Z",
"activeEndDate": "2019-08-24T14:15:22Z",
"boostedProductCodes": [
"string"
],
"blockedProductCodes": [
"string"
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| siteId | integer(int32) | false | none | none |
| searchTuningRuleCode | string¦null | false | none | none |
| searchTuningRuleName | string¦null | false | none | none |
| searchTuningRuleDescription | string¦null | false | none | none |
| keywords | [string]¦null | false | none | none |
| filters | [SearchTuningRuleFilter]¦null | false | none | none |
| active | boolean | false | none | none |
| isDefault | boolean | false | none | none |
| activeStartDate | string(date-time)¦null | false | none | none |
| activeEndDate | string(date-time)¦null | false | none | none |
| boostedProductCodes | [string]¦null | false | none | none |
| blockedProductCodes | [string]¦null | false | none | none |
| auditInfo | AuditInfo | false | none | none |
SearchTuningRuleCollection
{
"startIndex": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0,
"items": [
{
"siteId": 0,
"searchTuningRuleCode": "string",
"searchTuningRuleName": "string",
"searchTuningRuleDescription": "string",
"keywords": [
"string"
],
"filters": [
{
"field": "string",
"value": "string"
}
],
"active": true,
"isDefault": true,
"activeStartDate": "2019-08-24T14:15:22Z",
"activeEndDate": "2019-08-24T14:15:22Z",
"boostedProductCodes": [
"string"
],
"blockedProductCodes": [
"string"
],
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| pageCount | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [SearchTuningRule]¦null | false | none | none |
SearchTuningRuleSortFields
{
"sortFields": [
"string"
],
"inclusionExclusionType": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| sortFields | [string]¦null | false | none | none |
| inclusionExclusionType | string¦null | false | none | none |
FieldWeight
{
"searchFieldName": "string",
"weight": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| searchFieldName | string¦null | false | none | field in the index to target |
| weight | integer(int32) | false | none | weight to apply to boost field |
SuggestSettings
{
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fieldWeights | [FieldWeight]¦null | false | none | none |
| personalizationExperience | string¦null | false | none | none |
| personalizationFactor | number(double)¦null | false | none | none |
| returnFields | [string]¦null | false | none | none |
BoostValue
{
"value": "string",
"boost": 0,
"operator": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | string¦null | false | none | none |
| boost | integer(int32) | false | none | none |
| operator | string¦null | false | none | none |
BoostField
{
"fieldName": "string",
"valueExpressions": [
{
"value": "string",
"boost": 0,
"operator": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fieldName | string¦null | false | none | none |
| valueExpressions | [BoostValue]¦null | false | none | none |
FieldValueBoost
{
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
{
"value": "string",
"boost": 0,
"operator": "string"
}
]
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| boostType | string¦null | false | none | none |
| fields | [BoostField]¦null | false | none | none |
ListingSettings
{
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
{
"value": null,
"boost": null,
"operator": null
}
]
}
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| customBoosts | [string]¦null | false | none | none |
| fieldValueBoost | FieldValueBoost | false | none | none |
| personalizationExperience | string¦null | false | none | none |
| personalizationFactor | number(double)¦null | false | none | none |
ProductSuggestSettings
{
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
{
"value": null,
"boost": null,
"operator": null
}
]
}
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| customBoosts | [string]¦null | false | none | none |
| fieldValueBoost | FieldValueBoost | false | none | none |
| searchChildProductsByDefault | boolean | false | none | none |
| fieldWeights | [FieldWeight]¦null | false | none | none |
| personalizationExperience | string¦null | false | none | none |
| personalizationFactor | number(double)¦null | false | none | none |
| returnFields | [string]¦null | false | none | none |
SiteSearchFieldWeight
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
A custom field and weight value for search relevancy
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| phraseWeight | integer(int32) | false | none | weight to apply in phrase boosting |
| searchFieldName | string¦null | false | none | field in the index to target |
| weight | integer(int32) | false | none | weight to apply to boost field |
SiteSearchSettings
{
"fieldWeights": [
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
{
"value": null,
"boost": null,
"operator": null
}
]
}
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fieldWeights | [SiteSearchFieldWeight]¦null | false | none | [A custom field and weight value for search relevancy] |
| customBoosts | [string]¦null | false | none | none |
| fieldValueBoost | FieldValueBoost | false | none | none |
| minimumMatchPercents | [integer]¦null | false | none | none |
| phraseSlop | integer(int32) | false | none | none |
| personalizationExperience | string¦null | false | none | none |
| personalizationFactor | number(double)¦null | false | none | none |
| searchChildProductsByDefault | boolean | false | none | none |
SearchSettings
{
"settingsName": "string",
"isDefault": true,
"siteSearchSettings": {
"fieldWeights": [
{
"phraseWeight": 0,
"searchFieldName": "string",
"weight": 0
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
},
"productSuggestSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"categorySuggestSettings": {
"fieldWeights": [
{
"searchFieldName": "string",
"weight": 0
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"listingSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
{
"fieldName": "string",
"valueExpressions": [
null
]
}
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
Settings to control product search and indexing behavior
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| settingsName | string¦null | false | none | none |
| isDefault | boolean | false | none | none |
| siteSearchSettings | SiteSearchSettings | false | none | none |
| productSuggestSettings | ProductSuggestSettings | false | none | none |
| categorySuggestSettings | SuggestSettings | false | none | none |
| listingSettings | ListingSettings | false | none | none |
| auditInfo | AuditInfo | false | none | none |
SearchSettingsCollection
{
"totalCount": 0,
"items": [
{
"settingsName": "string",
"isDefault": true,
"siteSearchSettings": {
"fieldWeights": [
{
"phraseWeight": null,
"searchFieldName": null,
"weight": null
}
],
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
null
]
},
"minimumMatchPercents": [
0
],
"phraseSlop": 0,
"personalizationExperience": "string",
"personalizationFactor": 0,
"searchChildProductsByDefault": true
},
"productSuggestSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
null
]
},
"searchChildProductsByDefault": true,
"fieldWeights": [
{
"searchFieldName": null,
"weight": null
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"categorySuggestSettings": {
"fieldWeights": [
{
"searchFieldName": null,
"weight": null
}
],
"personalizationExperience": "string",
"personalizationFactor": 0,
"returnFields": [
"string"
]
},
"listingSettings": {
"customBoosts": [
"string"
],
"fieldValueBoost": {
"boostType": "string",
"fields": [
null
]
},
"personalizationExperience": "string",
"personalizationFactor": 0
},
"auditInfo": {
"updateDate": "2019-08-24T14:15:22Z",
"createDate": "2019-08-24T14:15:22Z",
"updateBy": "string",
"createBy": "string"
}
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| totalCount | integer(int32) | false | none | none |
| items | [SearchSettings]¦null | false | none | [Settings to control product search and indexing behavior] |